3.7 接口文档的维护

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

· 请求URL。

· 接口的负责人名称。

· 请求方法（GET或POST等）。

· 接口版本号。

· APP端应发送的数据和格式，及数据中每个字段的类型。

· 服务器端的处理成功时，返回的数据和格式及数据中每个字段的类型。

· 服务器端的处理失败时，返回的数据和格式及数据中每个字段的类型。

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