API说明书规范

   

目录

1      

1.1        

1.2        

1.3        

2      

3      

4      

4.1        

4.2        

4.2.1         

4.2.2         

4.2.3         

4.3        

4.3.1          

4.4        

 

 

1    前言 1.1   编写目的

信息系统不可避免会与三方系统产生交互，本文档将会定义信息系统体系下所有接口文档的一些通用约定。

API设计开发完成后，在保证API完整性和稳定性的情况下，需要对API接口进行详细的说明，本文档将约定如何对API接口进行说明。

注：本文档中所提及接口，都是信息系统对外提供的接口，接口作为被调用方，而不是指三方系统需要ERP去调用的接口。

1.2   预期读者

ERP系统接口设计开发人员

ERP系统接口使用人员

ERP系统三方对接公司

1.3   关于API设计开发

为信息系统开发的API需要仔细考虑，API地址名称、API输入参数、API返回值都应经过严格推敲，API是提供外部三方调用，需要经过严格测试，特别是对于会修改系统数据的API要有严格的参数验证和安全性验证。