Api接口开发正确姿势

目录

1.通信说明

接口整体规范建议采用Restful风格，客户端与服务器采用json通信协议。

2.请求

类型

Content-Type: application/json

参数

数据格式

{
  "productId": "1", 
  "productName": "测试"
}

3.响应说明

http状态码

200 OK 服务器成功返回请求的数据
201 CREATED 新建或修改数据成功
202 Accepted 表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT 删除数据成功
400 INVALID REQUEST 请求有错误，服务器没有进行新建或修改数据的操作（幂等操作）
401 Unauthorized 没有权限（令牌、用户名、密码错误）
403 Forbidden 得到授权（与401错误相对），但是访问是被禁止的
404 NOT FOUND 请求记录不存在，服务器没有进行操作（幂等操作）
406 Not Acceptable 请求的格式不符合（比如用户请求JSON格式，但是只有XML格式）
500 INTERNAL SERVER ERROR 服务器发生错误，无法判断发出的请求是否成功

返回格式

{
  "code": "1", // 业务响应状态码
  "data": {}, // 返回数据对象
  "msg": []     // 对应的错误信息
}

3.获取数据

POST /get/xx/{productId}：获取一个商品详情信息

例： https://xx.com/get/productDetail/123

4.提交数据

POST /add/xx 提交保存一个商品信息

请求json数据:
{
“productName”:“测试”
}

例： https://xx.com/add/product

5.更新数据

POST /update/xx 修改一个商品信息

请求json:
{
“productId”:“123”,
“productName”:“测试”
}

例： https://xx.com/update/product

6.删除数据

POST /delete/xx/{productId} 删除一个商品

例： https://xx.com/delete/product/123