后端服务层路由

概述

后端服务层路由完全按照 RESTful 接口规范

路由说明

方法

可支持五种HTTP方法，根据HTTP规范，动词一律大写

• GET
  • 获取资源（SELECT）
  • 安全且幂等
  • 常用
• POST
  • 创建资源（INSERT）
  • 不安全且不幂等
  • 常用
• PUT
  • 更新资源（UPDATE）
  • 不安全但幂等
• PATCH
  • 更新资源（UPDATE）
  • 不安全但幂等
  • 通常是部分更新
• DELETE
  • 删除资源（DELETE）
  • 不安全但幂等

怎么理解幂等性：HTTP幂等方法，是指无论调用多少次都不会有不同结果的HTTP方法。不管是调用一次，还是一百次、一千次，结果都是相同的。

资源

• 所有事物都被抽象为资源。资源是HTTP动词作用的对象，所以它应该是名词，不能是动词；
• 一个好的命名应该是能够充分描述它所代表的资源；
• 资源使用复数和单数并没有统一的规定，但是建议使用复数，一般常见的操作是读取一个集合，当然如果资源是没有集合的概念就可以用单数。

示例

此处以用户为例，包含以下接口：

• 获取用户
• 获取单条用户
• 新增用户
• 编辑用户
• 启用/禁用用户

1. 获取用户

获取用户信息

GET /users

2. 获取单条用户，id为用户id

根据用户id，获取该用户信息

GET /users/{id:\d+}

3. 新增用户

POST /users

4. 编辑用户

根据用户id，修改该用户信息

PATCH /users/{id:\d+}

5. 启用/禁用用户

根据用户id，启用/禁用该用户

PATCH /users/{id:\d+}/{status:enable|disable}