物联网软件开发与定制 22个优秀施行助你API推敲能力更进一竿
【编者的话】为推敲REST API而郁闷?不要慌物联网软件开发与定制，这里有推敲REST API的超实用苛刻!
也曾因为一个厄运的API而感到不振吗?
在这个微做事的全国里，后端API的一致性推敲是必不成少的。
180期：梅花照玉堂，假金镀真金开（918）
[扫码下载app，中过数字彩1千万以上的专家都在这儿！]
今天，咱们将商榷一些可撤职的最好施行。咱们将保抓概况和甜密-是以系好安全带，启程咯!
[[424906]]
领先先容一些术语任何API推敲齐撤职一种叫作念“面向资源推敲”的原则
资源：资源是数据的一部分，举例：用户 汇集：一组资源称为汇集，举例：用户列表 URL：记号资源或汇集的位置，举例：/用户 1. 对URL使用kebab-case(短横线小写离隔花式)举例，要是你思要得回订单列表。
不应该:
/systemOrders或/system_orders 物联网软件开发与定制app
应该:
/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、微做事范畴。