接口文档规范

前言：为了规范化项目管理，方便团队扩充后的新同事对项目的熟悉及自主入手开发，现决定将项目文档逐步规范化。

1. 所有新增接口，按照规范格式撰写接口文档；
2. 所有修改的接口，如果之前有对应的接口文档，则修改相应文档，若没有，则新建接口文档；
3. 文档目录位置的选择，以类似“商户后台→对账中心（大板块）→所有账单（子板块）”的方式建立或选择；
4. 同一个页面，一类功能的不同接口，可以放在同一个文档中；
5. 文档应清晰包含每个接口的请求参数说明、正确返回示例、错误返回示例、返回参数说明。参数不同值有不同特殊意义的，应在说明中列举，或使用单独的表格列举；
6. 不论前端工程师或后端工程师均可指定接口，只要商定好后即可撰写，双方各自按约定接口进行开发；
7. 开发测试过程中，对接口有修改的，应及时修改对应文档；
8. 任务下面需要进行接口对接的，直接贴文档地址进行交流。

Tips：接口调用可使用Postman，需要模拟浏览器环境（共享Cookie等），请打开Interceptor，如图所示