URL约定，方法，错误（"GET"，"POST"，"PUT"，"DELETE"）

可靠且易于理解的API从清晰的接口构建规则开始。我们遵循REST最佳实践,以确保每个开发人员都知道会发生什么：URL结构是合乎逻辑的,方法对应于操作,错误易于解释。

这降低了登录阈值，简化了集成，并允许在没有混乱的情况下扩展系统。

URL和HTTP方法约定

• 嵌套实体被描述为层次结构（'/users/42/sessions'）
• 所有查询均通过HTTPS进行

错误处理标准

json
{
"error": {
"code": 400,   "message": "Missing required field: email",   "details": {...}
}
}

对开发人员的好处

• 所有模块和实体的统一方法
• 通过标准代码和格式轻松调试和编写
• 与OpenAPI/Swagger、Postman、SDK自动生成兼容
• 简化支持、测试和CI/CD

在哪里，特别重要

• 具有多个开发团队的项目
• 微服务体系结构或API第一方法
• 具有大量实体和交互的系统

统一约定使API可靠，易于理解和方便。我们坚持最好的REST做法,以确保每次集成都能快速进行,没有误解,并具有最大的可预测性。