一、双方统一接口开发文档为了提升开发效率及沟通方便，需要建立规范的开发文档。 一般保护接口的功能或页面、接口地址、接口参数、接口返回值等说明。
参考文档格式： 
二、注意以下
分版本，为后面接口升级做好打算。
提供密钥和token。确保数据不被篡改。
-
读数据用get，修改数据用post。
立即学习“PHP免费学习笔记（深入）”；
接口返回值格式统一结构。 用JSON格式输出
接口记录日志。记录请求参数、占用内存、响应时间、响应时长。方便后续优化。
提供统一的错误码。每个数字代表一种错误，需要在文档中说明。错误分系统错误和业务逻辑错误。 建立接口文档。
记录每个接口的用途，参数列表，返回值说明。同时给出使用例子。
一、双方统一接口开发文档
为了提升开发效率及沟通方便，需要建立规范的开发文档。
一般保护接口的功能或页面、接口地址、接口参数、接口返回值等说明。
参考文档格式：
二、注意以下
分版本，为后面接口升级做好打算。
提供密钥和token。确保数据不被篡改。
-
读数据用get，修改数据用post。
立即学习“PHP免费学习笔记（深入）”；
接口返回值格式统一结构。 用JSON格式输出
接口记录日志。记录请求参数、占用内存、响应时间、响应时长。方便后续优化。
提供统一的错误码。每个数字代表一种错误，需要在文档中说明。错误分系统错误和业务逻辑错误。 建立接口文档。
-
记录每个接口的用途，参数列表，返回值说明。同时给出使用例子。
相关推荐：
