22条API设计的实践
2022-02-14 14:16:57 0 举报AI智能生成
登录查看完整内容
22条API设计的实践
作者其他创作
大纲/内容
/system-orders
1、对URL使用kebab-case（短横线小写隔开）
/system-orders/{orderId}
2、参数使用camelCase（驼峰形式）
/users
3、指向集合的复数名称
/shops/:shopId/
4、URL以集合开始，以标识符结束
PUT /user/{userId}
5、让动词远离你的资源URL
第一部分
POST /alarm/245743/resend
6、对非资源URL使用动词
7、JSON属性使用camelCase驼峰形式
/health
/version
/metrics
8、监控
product_order -> product-orders
9、不要使用table_name作为资源名
swagger...
10、使用API设计工具
第二部分
/v1/shops/3/products
11、使用简单序数作为版本
12、在你的响应体中包括总资源数
GET /shops?offset=5&limit=5
13、接受limit和offset参数
14、获取字段查询参数
15、不要在URL中通过认证令牌
content-type: application/json
16、验证内容类型
第三部分
GET：检索资源的表示形式
POST：创建新的资源和子资源
PUT：更新现有资源
PATCH：更新现有资源，它只更新提供的字段
DELETE：删除已存在的资源
17、对CRUD函数使用HTTP方法
GET /shops/2/products：从shop 2获取所有产品的列表
GET /shops/2/products/31：获取产品31的详细信息，产品31属于shop 2
18、在嵌套资源的URL中使用关系
支持CORS允许的“*”来源
19、CORS（跨源资源共享）
强制并要求所有回调url、推送通知端点和webhooks使用HTTPS
20、安全
服务器能响应客户端的各种错误
21、错误
扁平比嵌套好
简单胜于复杂
字符串比数字好
一致性比定制更好
22、黄金法则
第四部分
22条API设计的实践
0 条评论
回复 删除
下一页
