接口文档api说明模板.md

XXXX接口文档

时间	变更人	变更说明	版本
2020年10月28日14:12:00	XXX	update	修改版本为v2
2020年04月21日12:02:00	XXX	new	v1

用户请求接口

[http://{host}:{port}/v2/XXX/login

POST

属性	值
Content-Type	application/json

请求参数	参数类型	必传	默认值	参数说明
username	String	true		用户名
passwd	String	true		密码

{
  "username": "xdb",
  "passwd":"123456"
}

返回参数	参数类型	参数说明
code	int	200:成功, 400:失败
msg	string	响应消息

响应成功

{
  "code": 200,
  "msg": "成功"
}

响应失败

{
  "code": 400,
  "msg": "用户名或密码错误"
}