markdown写后台api文档

2019-04-24  本文已影响0人  帶頭二哥

接口文档示例

类型 服务器地址
<font color=red>Test http://xxx.xxx.xxx:xxx
<font color=red>Develop http://xxx.xxx.xxx:xxx
<font color=red>Product http://xxx.xxx.xxx:xxx

用户模块

接口 请求方式 说明
/user POST 用户登录
/user GET 获取用户详情

接口详情

* JSON请求示例:

         "Header":{
             "token": "",
         }
          "Body":{
             "username": "",
             "password": "",
         }  
    

* 返回参数说明:

    | 名称 | 类型 |说明|
    |----- |------|----|
    | code | int| 状态码
    | data | object|具体数据|
    | token | string|登录方式|

* JSON返回示例:

         {
             "code": 200,
             "data": {
                 "token": "1234567890",
             }
         }


响应码说明

响应码 说明
200 处理成功
301 解析报文错误
302 无效调用凭证
303 参数不正确
500 系统内部错误
999 处理失败
上一篇下一篇

猜你喜欢

热点阅读