美文网首页
接口文档格式

接口文档格式

作者: 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 登录过期!

    相关文章

      网友评论

          本文标题:接口文档格式

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