亚博官网网站积分兑换规则_22个优秀实践助你API筹备才调更进一竿

发布日期：2023-10-30 03:29 点击次数：193

亚博官网网站积分兑换规则_22个优秀实践助你API筹备才调更进一竿

亚博官网网站积分兑换规则_

【编者的话】为筹备REST API而麻烦?不要慌宝马会炸金花，这里有筹备REST API的超实用提倡!

也曾因为一个灾祸的API而感到颓靡吗?

在这个微作事的宇宙里，后端API的一致性筹备是必不行少的。

今天，咱们将征询一些可服从的最好实践。咱们将保执概况和甜密-是以系好安全带，开拔咯!

[[424906]]

最初先容一些术语

任何API筹备皆服从一种叫作念“面向资源筹备”的原则

资源：资源是数据的一部分，举例：用户归并：一组资源称为归并，举例：用户列表 URL：标记资源或归并的位置，举例：/用户 1. 对URL使用kebab-case(短横线小写离隔体式)

举例，若是你念念要取得订单列表。

不应该:

/systemOrders或/system_orders 宝马会炸金花

应该:

/system-orders

2. 参数使用camelCase(驼峰体式)

举例，若是你念念从一个特定的商店购买居品。

不应该:

/system-orders/{order_id}或/system-orders/{OrderId}

应该:

/system-orders/{orderId}

3.指向归并的复数称号

若是你念念取得系统的总共用户。

不应该:

GET /user或GET /User

应该:

GET /users

4. URL以归并运行，以标记符驱散

若是要保执主意的单一性和一致性。

不应该:

GET /shops/:shopId/category/:categoryId/price

这很灾祸，因为它指向的是一个属性而不是资源。

应该:

GET /shops/:shopId/或GET /category/:categoryId

5. 让动词远隔你的资源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"  }

皇冠客服飞机：@seo3687

应该：

{ userName: &quot;Mohammad Faisal&quot; userId: &quot;1&quot; }

8. 监控

RESTful HTTP作事必须罢了/health和/version和/metricsAPI端点。他们将提供以下信息。

/health

用200 OK气象码响支吾/health的肯求。

/version

用版块号响支吾/version的肯求。

/metrics

这个端点将提供多样方针，如平均反当令辰。

新2手机网址

也热烈保举使用/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被外部实体使用，鼎新端点可能会梗阻它们的功能。

皇冠体育hg86a

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

此外，授权令牌应该是顷刻灵验期的。

据悉，青岛机场将通过增派现场人手、前移服务点位、加开人工值机柜台、动态调整安检通道开放数量等方式，加强航站楼内的问询引导、旅客分流、秩序维护工作，聚焦首乘旅客、快线旅客、中转旅客、无陪老人、无陪儿童等旅客群体提供及时帮助，全面提升现场服务保障水平。

皇冠新2网址 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神气的决定有疑问，这些黄金规定不错匡助咱们作念出正确的决定。