一、 写明该api接口文档的功能是什麼
二、 请求的URL是什么
四、 参数是什么此处还需说明你的参数名、参数类型、是否必填、参数的简单解释
五、 请求成功时的响应内容（实際开发中，要与前端同事沟通使用什么样的数据结构）并且对其中的字段做出说明（包括含义、数据类型，数据结构<字符串数组，字典等>）
六、 请求失败时的响应内容并且对其中的字段做出说明（包括含义、数据类型，数据结构<字符串数组，字典等>）包括单独的对錯误码的说明
七、 请求样例（返回结果部分要包括成功的情况和失败的情况）
八、 最好写上文档的编写人和编写时间（可不写）
发布了52 篇原创文章 · 获赞 5 · 访问量 2万+
