接口文件模板(在markdown中想显示代码需在代码前加两个空格)

创建.md文档(根据实际情况编写)。

#注册
##用户添加
####请求地址
  /api/users/add
####请求方式(GET|POST)
  POST
####请求参数
  {
  "username":"zhangsan",//[字符串:必填]
  "password":"abc123",//[字符串:必填]
  "roles":"0",//用户角色[字符串:必填]0管理员 1讲师 2学员【2-1未毕业(2-1-1未毕业第1阶段 2-1-2未毕业第2阶段 ...) 2-2已毕业(2-2-1已毕业过试用期 2-2-2已业未过试用期)】
  }
####返回数据
  {
  "errcode":0,//错误代码:[数值:必填]0无错误 -1有错误
  "errmsg":"",//错误信息:[字符串:默认为空]
  "data":{//数据内容
  "status":"ok",//存取状态 :[字符串:必填]"ok"成功 "fail"失败
  "msg":"数据存取成功"//附加信息:[字符串:选填]
    }
  }

posted @ 2021-09-16 15:59  yuchenjing  阅读(86)  评论(0编辑  收藏  举报