【数据网关规范】路由

设计规范

RESTful API

设计准则

1. 结构："动词" + "宾语"，例如：GET /teams, GET是动词，/teams是宾语
2. 宾语必须是名词，因为请求方法已经有动作的方法，所以URL应该是名词，而不应该再包含动作，比如，获取战队列表
   • 正确：/teams
   • 错误：/getTeamList

3. 单数 or 复数？资源路由路由 URI 必须使用复数形式，比如，获取某个战队的信息

   • 正确: /teams/{id}
   • 错误: /team/{id}

模块化

• 模块A：${domain}/a/${route_path}
• 模块B：${domain}/b/${route_path}
• ...

接口版本

${domain}/${module}/v1/${route_path}

请求方法

面向网关，只需提供 GET 方法

查询参数

灵活 + 统一

• 分页：?page[number]=2&page[size]=50
• 条件：?filter[status]=2&filter[time]=1m
• 排序：?sort=-id