正确规范写api接口文档

一.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。

接口1 查询排重接口:
接口详情
请求地址/api/user/login/
请求方式GET
参数是否必填说明
phone手机号码
password密码
返回结果说 明
success返回登录状态,true–登录成功,flase–登录失败
msg返回登录信息
name用户名
sessionId返回存入session的标识
返回结果案例

具体返回结果举例:

{
	"success": true,
	"msg": "登录成功!",
	"name": "test",
    "sessionId": "6cdf33e6-b037-4ddb-bdce-5158335ffd18",
}
{
	"msg": "账号不存在",
	"success": false
}
{
	"msg": "密码错误",
	"success": false
}
  • 1
    点赞
  • 0
    评论
  • 5
    收藏
  • 一键三连
    一键三连
  • 扫一扫,分享海报

©️2021 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值