RESTFul 风格 API 设计

修订记录

注意事项

• 类型是属性类型，只有 String、Number、Object、Array
• 编码格式默认为 utf-8

接口说明

1. 商品新增[单个]

• 请求地址： post /api/{version}/products
• 请求参数：

• 返回参数:

2. 商品新增[批量]

• 请求地址： post /api/{version}/products
• 请求参数：

其中，datas 中的一个 data：

• 返回参数:

3. 查看商品详情

• 请求地址： get /api/{version}/products/{id}
• 请求参数：

• 返回参数：

其中，data：

4. 查看商品详情列表

• 请求地址： get /api/{version}/products
• 请求参数：

• 返回参数：

其中，datas：

5. 修改商品状态

• 请求地址： put /api/{version}/products/{id}/{status}
• 请求参数

• 返回参数

6. 删除商品

• 请求地址： delete /api/{version}/products/{id}
• 请求参数：

• 返回参数

通用例子

• GET /products : 返回所有商品列表
• POST /products : 将商品加入到里商品列表中
• GET /products/4 : 获得 4 号商品
• PATCH/PUT /products/4 : 更新 4 号商品
• DELETE /products/4 : 删除 4 号商品

参考资料

• https://crzidea.com/2016/08/12/koa-restql/
• https://www.zhihu.com/question/36706936
• https://www.zhihu.com/question/28557115