API接口文档说明

API文档规范要求
一、 写明该接口的功能是什么
二、 请求的URL是什么
三、 请求方式是什么（POST、GET、 DELETE、PUT、 PATCH等）
四、 参数是什么，此处还需说明你的参数名、参数类型、是否必填、参数的简单解释
五、 请求成功时的响应内容（实际开发中，要与前端同事沟通使用什么样的数据结构），并且对其中的字段做出说明（包括含义、数据类型，数据结构<字符串，数组，字典等>）
六、 请求失败时的响应内容，并且对其中的字段做出说明（包括含义、数据类型，数据结构<字符串，数组，字典等>）包括单独的对错误码的说明
七、 请求样例（返回结果部分要包括成功的情况和失败的情况）
八、 最好写上文档的编写人和编写时间（可不写）