API部分规范

// 单条
{
  "id": 1,
  "username": "Kevin",
  "avatar_url": "http://abc.com/avatar.jpg"
}

// 多条
[
  {
    "id": 1,
    "username": "Kevin",
    "avatar_url": "http://abc.com/avatar.jpg"
  },
  {
    "id": 2,
    "username": "John",
    "avatar_url": "http://abc.com/avatar.jpg"
  }
]

// 多条（带分页）
{
  "page": {
    "total": 10,
    "current": 1,
  },
  "items": [
    {
      "id": 1,
      "username": "Kevin",
      "avatar_url": "http://abc.com/avatar.jpg"
    },
    {
      "id": 2,
      "username": "John",
      "avatar_url": "http://abc.com/avatar.jpg"
    }
  ]
}

// 操作
{
  "code": 1,
  "msg": "成功"
}

{
  "code": 0,
  "msg": "失败"
}

多条请求


请求
地址：http://api.mw.com/api/v1/json/a.json
格式：json
方式：get
请求示例：http://api.mw.com/api/v1/json/a.json&appkey=您申请的appkey&type=top100

请求参数：

名称 | 类型 | 必填 | 说明
type | String | 是 | top100
appkey | String | 是 | 码为appkey
page | Int | 否 | 分页获取数据（每页100条）

返回
{items: [{},{}], page:{}}

 {
   "items":
     [{  
       
     }
    ]
   "page":
       {

       }
  }

单条请求API


请求
地址：http://api.mw.com/api/v1/json/a.json
格式：json
方式：get
请求示例：http://api.mw.com/api/v1/json/a.json&appkey=您申请的appkey&id=12

请求参数：

名称 | 类型 | 必填 | 说明
id | Int | 是 | Id
appkey | String | 是 | 码为appkey

返回
{data: {code: 500 , update_time: "",  msg: "", result: {}}

 {
   "data":
     {  
       "code":200,
       "update_time":"2018\/07\/06 10:53", /*更新时间*/
       "msg":"",  

       "result":
               {"id": 12, "name": '毛巾' }
     }
  }

其它参考


Get请求

返回单条（一层结构）或者多条(数组每个元素为一层结构） {

 "username": 'kevin',
 "avatar_url": ”https://a.b.c/a.jpg“

} [

{
  "title": "标题",
  "price": 20
}
{}

]


非Get请求 { "code": "1111", "msg": "操作成功" }



接口返回正确/错误信息统一格式： {

 code:
 msg:
 data: {}


}



单独接口返回错误信息：


{ "error_response":{ "code":50, "msg":"Remote service error" } }


curl
curl -i -X POST -d "user[mpnumber]=136600047&user[password]=123456" http://localhost:3001/api/v1/json/sessions.json
curl -i -X PUT -d "favorite[user_id]=1, favorite[material_id]=2" \
  --header "Authorization: Token token=Bj5mPyUXkb5PaUAzz9+xK9gpPBrieGaWCSnCA72fxM00RTvC27yNvc2jFpMAmsF3vHK6YUZUXWccSA9LReHZ/Q==, \
  mpnumber=13667178947" \
  http://localhost:3000/api/v1/json/users/1/do_favorite



curl -i  -H "Content-Type:application/json" -X PUT -d '{"favorite":{"user_id":1, "material_id": 1,"note":"","from_site":""}}' --header "Authorization: Token token=Bj5mPyUXkb5PaUAzz9+xK9gpPBrieGaWCSnCA72fxM00RTvC27yNvc2jFpMAmsF3vHK6YUZUXWccSA9LReHZ/Q==, mpnumber=13667178947"   http://localhost:3001/api/v1/json/users/1/do_favorite.json



阅读量: 531
发布于:
修改于: