Api接口文档的编写及Api接口联调

Api接口文档的编写

为了方便协调客户端和服务端的开发，比如我们写好了服务端接口，客户端就需要调用，所以我们需要写接口文档以便于客户端调用，这样也能提高开发效率。

有利于客户端工程师熟悉接口

有利于服务端工程师接手项目

对于api的接口文档的编写，我们要写上入参和出参的数据格式，我们可以使用word，pdf，wiki进行文档编写，当然我们也可以使用线上文档编写接口。

api接口必须包含以下内容:

api接口地址

请求方式:get put post delete

入参格式

出参格式

http code

1使用postman生成接口文档

1在postman上注册一个用户账号和密码，完善个人信息

2创建一个collection创建时填好名称和描述（项目的名称）

3在collecttion下面创建一个目录（项目的模块）

4在目录下可以创建多个请求

5每个请求下可以创建多个实例（比如成功实例和错误实例）

6可以发布一个collection

2使用https://www.showdoc.cc 生成接口文档（推荐使用）

1 先注册一个showdoc的账号和密码。

2 我们可以新建一个项目

3 我们可以在项目中创建目录结构

4 我们可以新建文档，选择文档的模板。

注意:我们也可以使用api线上调试工具，调试接口一旦调试成功，我们可以生成markdown格式的文本，然后填充到api接口模板中。

接口联调

项目完成后我们要和前端的开发人员进行接口联调。一般有一个测试环境，在测试环境测试没问题，我们在进行上线运营。