【编者的话】为策画REST API而麻烦?不要慌巴黎世家 丝袜，这里有策画REST API的超实用提出!
也曾因为一个厄运的API而感到改悔吗?
天水在线在这个微作事的寰宇里，后端API的一致性策画是必不成少的。
今天，咱们将扣问一些可遵命的最好推行。咱们将保合手苟简和甜密-是以系好安全带，开赴咯!
[[424906]]
领先先容一些术语任何API策画齐遵命一种叫作念“面向资源策画”的原则
资源：资源是数据的一部分，举例：用户 邻接：一组资源称为邻接，举例：用户列表 URL：璀璨资源或邻接的位置，举例：/用户 1. 对URL使用kebab-case(短横线小写离隔姿首)举例，要是你思要获取订单列表。
不应该:
/systemOrders或/system_orders 巴黎世家 丝袜
应该:
/system-orders2. 参数使用camelCase(驼峰姿首)
举例，要是你思从一个特定的商店购买居品。
不应该:
/system-orders/{order_id}或/system-orders/{OrderId}
应该:
/system-orders/{orderId}
3.指向邻接的复数称号
要是你思获取系统的整个用户。
不应该:
GET /user或GET /User
应该:
GET /users4. URL以邻接运转，以璀璨符扫尾
要是要保合手看法的单一性和一致性。
不应该:
GET /shops/:shopId/category/:categoryId/price
这很厄运，因为它指向的是一个属性而不是资源。
应该:
GET /shops/:shopId/或GET /category/:categoryId5. 让动词辨别你的资源URL
不要在URL中使用动词来抒发你的意图。相背，使用相宜的HTTP轮番来描写操作。
不应该:
POST /updateuser/{userId}或GET /getusers
应该:
PUT /user/{userId}
6. 对非资源URL使用动词
要是你有一个端点，它只复返一个操作。在这种情况下，你不错使用动词。举例，要是你思要向用户再行发送警报。
应该:
POST /alarm/245743/resend
请记着，这些不是咱们的CRUD操作。相背，它们被合计是在咱们的系统中实施特定责任的函数。
7. JSON属性使用camelCase驼峰姿首要是你正在构建一个苦求体或反应体为JSON的系统，那么属性名应该使用驼峰大小写
不应该：
{ user_name: "Mohammad Faisal" user_id: "1" }
应该：
{ userName: "Mohammad Faisal" userId: "1" }
8. 监控
RESTful HTTP作事必须杀青/health和/version和/metricsAPI端点。他们将提供以下信息。
/health
用200 OK状况码反应酬/health的苦求。
/version
用版块号反应酬/version的苦求。
/metrics
这个端点将提供多样方针，如平均反应本领。
也热烈保举使用/debug和/status端点。
9. 不要使用table_name当作资源名不要只使用表名当作资源名。从永恒来看，这种懒惰是无益的。
不应该：product_order
应该：product-orders
这是因为公开底层体捆绑构不是你的方针。
10. 使用API策画器具有好多好的API策画器具用于编写好的文档，举例:
API蓝图 Swagger领有雅致而详备的文档不错为API使用者带来雅致的用户体验。
11. 使用粗浅序数当作版块永远对API使用版块箝制，并将其向降级徙，使其具有最大的作用域。版块号应该是v1， v2等等。
应该：
http://api.domain.com/v1/shops/3/products永远在API中使用版块箝制，因为要是API被外部实体使用，更变端点可能会高低它们的功能。
12. 在你的反应体中包括总资源数要是API复返一个对象列表，则反应中老是包含资源的总和。你不错为此使用total属性。
不应该：
{ users: [ ... ] }
应该：
{ users: [ ... ]， total: 34 }
13. 接纳limit和offset参数
在GET操作中永远接纳limit和offset参数。
应该：
GET /shops?offset=5&limit=5
这是因为它关于前端的分页是必要的。
14. 获取字段查询参数复返的数据量也应该商酌在内。添加一个fields参数，只公开API中必需的字段。
例子:
只复返商店的称号，地址和筹商形貌。
GET /shops?fields=id，name，address，contact
在某些情况下，它还有助于减少反应大小。
15. 不要在URL中通过认证令牌这是一种尽头厄运的作念法，因为url闲居被记载，而身份考据令牌也会被无须要隘记载。
不应该：
GET /shops/123?token=some_kind_of_authenticaiton_token
相背，通过甚部传递它们:
Authorization: Bearer xxxxxx， Extra yyyyy
此外，授权令牌应该是良晌灵验期的。
16. 考据内容类型作事器不应该假设内容类型。举例，要是你接纳application/x-www-form-urlencoded，那么袭击者不错创建一个表单并触发一个粗浅的POST苦求。
因此，永远考据内容类型，要是你思使用默许的内容类型，请使用content-type: application/json
17. 对CRUD函数使用HTTP轮番HTTP轮番用于解说CRUD功能。
GET：检索资源的默示姿首。 POST：创建新的资源和子资源。 PUT：更新现存资源。 PATCH：更新现存资源，它只更新提供的字段，而不更新其他字段。 DELETE：删除已存在的资源。 18. 在嵌套资源的URL中使用关系以下是一些骨子例子:
GET /shops/2/products：从shop 2获取整个居品的列表。 GET /shops/2/products/31：获取居品31的详备信息，居品31属于shop 2。 DELETE /shops/2/products/31：应该删除居品31，它属于商店2。 PUT /shops/2/products/31：应该更新址品31的信息，只在resource-URL上使用PUT，而不是邻接。 POST /shops：应该创建一个新的商店，并复返创建的新商店的详备信息。在邻接url上使用POST。 19. CORS(跨源资源分享)一定要为整个面向大师的api支持CORS(跨源资源分享)头部。
商酌支持CORS允许的“*”着手，并通过灵验的OAuth令牌强制授权。
幸免将用户证明与原始考据相趋奉。
20.安全在整个端点、资源和作事上实施HTTPS (tls加密)。
强制并条款整个回调url、推送示知端点和webhooks使用HTTPS。
21. 缺欠当客户端向作事发出无效或不正确的苦求，或向作事传递无效或不正确的数据，而作事停止该苦求时，就会出现缺欠，大约更具体地说，出现作事缺欠。
例子包括无效的身份考据证明、不正确的参数、未知的版块id等。
当由于一个或多个作事缺欠而停止客户端苦求时，一定要复返4xx HTTP缺欠代码。 商酌搞定整个属性，然后在单个反应中复返多个考据问题。 22. 黄金法例要是您对API姿首的决定有疑问，这些黄金章程不错匡助咱们作念出正确的决定。
扁平比嵌套好。 粗浅胜于复杂。 字符串比数字好。 一致性比定制更好。便是这么——要是你依然走到了这一步，恭喜你!但愿你学到了一些东西。
但愿你渡过好意思好的一天!
译者：Mr.lzc，软件工程师、DevOpsDays、HDZ深圳中枢组织者，现在供职于华为，从事云规画责任，专注于K8s、微作事鸿沟。