【编者的话】为想象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中通过认证令牌这是一种相配灾祸的作念法，迷幻商城150元因为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、微作事鸿沟。