美文网首页
接口文档格式

接口文档格式

作者: 0蛐蛐0 | 来源:发表于2018-09-13 14:22 被阅读11次

1、注册

提供手机号和密码的登录方式。

请求说明

请求方式:POST
请求URL :login

参数

字段 字段类型 字段说明
phone int 手机号
password string 密码返回结果

返回结果

{
  "data": 
  {
      "token": "eyJ0eXAiOiJKV1Qi", 
      "name": "小明", 
      "userid": "123456",
      "phone": "13788888888"
  },
  "code": 0,
  "msg": "SUCCESS"
}

返回参数

字段 字段类型 字段说明
token string token值
name string 用户名
userid string 用户id
phone string 电话号码

错误状态码

状态码(code) 说明
3001 其他认证错误信息!
3002 用户不存在!
3003 用户名或密码有误!

2、列表类数据

提供文章列表数据。

请求说明

请求方式:POST
请求URL:/article_list

参数

字段 字段类型 字段说明
page int 当前页数
per_page int 每页数据条数

返回结果

{
    "data": [
        {
            "article_title": "文章1",
            "article_id": "123456",
            "article_url": "http://123456"
        },
        {
            "article_title": "文章2",
            "article_id": "56789",
            "article_url": "http://56789"
        }
    ],
    "paged": {
        "size": 10,
        "more": 0,
        "total": 10,
        "page": 1
    },
    "code": 0,
    "msg": "SUCCESS"
}

返回参数

字段 字段类型 字段说明
data Array<article> 列表数据
paged object 返回分页信息
code int 返回错误码
msg string 返回错误提示信息

paged

字段 字段类型 字段说明
size int 每页条数(通常固定 10条)
more BOOL 是否还有更多
total int 共有多少条
page int 当前页数

错误状态码

状态码(code) 说明
3001 其他认证错误信息!
3002 用户不存在!
3003 登录过期!

相关文章

  • python 项目-后台接口文档字段翻译

    后台接口文档格式如下: 数据库文档格式如下数据库文档.png 最后得到翻译完成的接口文档 项目地址

  • 接口文档格式

    1、注册 提供手机号和密码的登录方式。 请求说明 请求方式:POST 请求URL :login 参数 返回结果...

  • 接口文档的编写

    参考资料 如何优雅的格式化接口 如何优雅的“编写”api接口文档 接口文档的编写

  • markdown写后台api文档

    接口文档示例 用户模块 接口详情 登录接口 接口地址:/user返回格式:Json请求方式:Post请求示例:/u...

  • php.api接口文档例子

    telechat接口文档 Date: 2018/07/05Author: xkan 接口格式说明 url:请求ur...

  • 接口文档

    接口文档 接口统一返回格式 所有请求的HEADER Accept application/json Content...

  • Swagger离线文档生成

    离线接口文档自动生成器 适用范围: 将标准的swagger.json文件解析并转换成一定格式的接口文档,其中文档的...

  • 一些tips

    如何测试? 接口文档+需求文档,重接口 如何测试视频? 视频格式,1080p,突出技术含量,更想看到你的专业程度 ...

  • 怎么管理接口文档

    1、利用swagger生成接口文档(json格式) 2、利用yapi进行展示 把用swagger生成的json格式...

  • swagger

    初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于...

网友评论

      本文标题:接口文档格式

      本文链接:https://www.haomeiwen.com/subject/isywgftx.html