API文档

1. API文档命名规则

api文档创建时,按照api/url的规则来命名,例如:url:test.html,api文档的名应该为:api/test.html。

如果是视口,那么应该把后缀json改为html,例如:url:test.createuser.json,api文档名应该为:api/test.createuser.html。

2. 创建页面

2.1 按照api文档的命名规则创建页面,导出技术经理给出的api文档模板。

2.2 在创建的页面导入模板。

3. 目标地址

目标地址就是需要写api文档的视口地址。例如:需要给test.html视口写一个api文档,则目标地址为:/test.html。

4. 描述

详细说明这个页面动态化后主要实现什么功能。

5. 输入参数

页面动态化时的输入参数设置,需要详细说明输入参数的名称,是否必选,类型,以及输入参数的描述。

6. 返回参数

页面动态化时的输出参数设置,需要详细说明输出参数的名称,类型,以及返回参数的描述。

7. 返回json样例

在打开的页面URL后输入:?ct=public_json,就可看到返回的json数据。