APP开发实战13-接口文档的维护

3.6接口文档的维护

接口文档通常由服务器端负责接口开发的同事维护，对于每个接口的描述，应包括以下内容：

(1)   请求URL。

(2)   接口的负责人名称。

(3)   请求方式GET或POST。

(4)   接口版本号。

(5)   APP端应发送的数据和格式。

(6)   服务器端的操作成功时，返回的数据和格式。

(7)   服务器端的操作失败时，返回的数据和格式。

 

最好使用版本管理工具如SVN管理接口文档，每次把文档提交到服务器时，都要填写修改说明，方便APP开发人员和测试人员了解接口的变更。