接口文档示例

接口说明

说明此接口的功能是做什么的

示例：实现用户登录功能

接口请求地址：

https://xxx.xxx.xxx

示例：https://test.cn/auth/login

请求头：

请求方式：

POST/GET

参数类型：JSON

请求体：

{
    "email":"2388347@163.com",
    "password":"123456"
}

请求体参数说明：

字段名	说明	类型	是否必填
字段1	作用描述	varchar(64)	是
字段2	作用描述	int	是

响应参数：

返回码	返回格式
200	{         “code”:200         “msg”:“成功” }
400	{         “code”:400         “msg”:“请求参数异常” }
500	{         “code”:500         “msg”:“系统异常” }