秋霞久久久久久一区二区,美女被cao网站免费看在线看,免费男女羞羞的视频网站中文版

user_name: "Mohammad Faisal"
user_id: "1"
}

應(yīng)該：

{

   userName: "Mohammad Faisal"

   userId: "1"

}

8. 監(jiān)控

RESTful HTTP服務(wù)必須實(shí)現(xiàn)/health和/version和/metricsAPI端點(diǎn)。他們將提供以下信息。

/health

用200 OK狀態(tài)碼響應(yīng)對(duì)/health的請求。

/version

用版本號(hào)響應(yīng)對(duì)/version的請求。

/metrics

這個(gè)端點(diǎn)將提供各種指標(biāo)，如平均響應(yīng)時(shí)間。

也強(qiáng)烈推薦使用/debug和/status端點(diǎn)。

9. 不要使用table_name作為資源名

不要只使用表名作為資源名。從長遠(yuǎn)來看，這種懶惰是有害的。

不應(yīng)該：

product_order

應(yīng)該：

product-orders

這是因?yàn)楣_底層體系結(jié)構(gòu)不是你的目的。

10. 使用API設(shè)計(jì)工具

有許多好的API設(shè)計(jì)工具用于編寫好的文檔，例如：

API藍(lán)圖：https://apiblueprint.org/
Swagger：https://swagger.io/

擁有良好而詳細(xì)的文檔可以為API使用者帶來良好的用戶體驗(yàn)。

11. 使用簡單序數(shù)作為版本

始終對(duì)API使用版本控制，并將其向左移動(dòng)，使其具有最大的作用域。版本號(hào)應(yīng)該是v1，v2等等。

應(yīng)該：http://api.domain.com/v1/shops/3/products

始終在API中使用版本控制，因?yàn)槿绻?a href="http://m.dlbhg.com/blog/api-what-is-api/">API被外部實(shí)體使用，更改端點(diǎn)可能會(huì)破壞它們的功能。

12. 在你的響應(yīng)體中包括總資源數(shù)

如果API返回一個(gè)對(duì)象列表，則響應(yīng)中總是包含資源的總數(shù)。你可以為此使用total屬性。

不應(yīng)該：

{

  users: [ 

     ...

  ]

}

應(yīng)該：

{

  users: [ 

     ...

  ],

  total: 34

}

13. 接受limit和offset參數(shù)

在GET操作中始終接受limit和offset參數(shù)。

應(yīng)該：

GET /shops?offset=5&limit=5

這是因?yàn)樗鼘?duì)于前端的分頁是必要的。

14. 獲取字段查詢參數(shù)

返回的數(shù)據(jù)量也應(yīng)該考慮在內(nèi)。添加一個(gè)fields參數(shù)，只公開API中必需的字段。

例子：

只返回商店的名稱，地址和聯(lián)系方式。

GET /shops?fields=id,name,address,contact

在某些情況下，它還有助于減少響應(yīng)大小。

15. 不要在URL中通過認(rèn)證令牌

這是一種非常糟糕的做法，因?yàn)閡rl經(jīng)常被記錄，而身份驗(yàn)證令牌也會(huì)被不必要地記錄。

不應(yīng)該：

GET /shops/123?token=some_kind_of_authenticaiton_token

相反，通過頭部傳遞它們：

Authorization: Bearer xxxxxx, Extra yyyyy

此外，授權(quán)令牌應(yīng)該是短暫有效期的。

16. 驗(yàn)證內(nèi)容類型

服務(wù)器不應(yīng)該假定內(nèi)容類型。例如，如果你接受application/x-www-form-urlencoded，那么攻擊者可以創(chuàng)建一個(gè)表單并觸發(fā)一個(gè)簡單的POST請求。

因此，始終驗(yàn)證內(nèi)容類型，如果你想使用默認(rèn)的內(nèi)容類型，請使用：

content-type: application/json

17. 對(duì)CRUD函數(shù)使用HTTP方法

HTTP方法用于解釋CRUD功能。

GET：檢索資源的表示形式。

POST：創(chuàng)建新的資源和子資源。

PUT：更新現(xiàn)有資源。

PATCH：更新現(xiàn)有資源，它只更新提供的字段，而不更新其他字段。

DELETE：刪除已存在的資源。

18. 在嵌套資源的URL中使用關(guān)系

以下是一些實(shí)際例子：

GET /shops/2/products：從shop 2獲取所有產(chǎn)品的列表。
GET /shops/2/products/31：獲取產(chǎn)品31的詳細(xì)信息，產(chǎn)品31屬于shop 2。
DELETE /shops/2/products/31：應(yīng)該刪除產(chǎn)品31，它屬于商店2。
PUT /shops/2/products/31：應(yīng)該更新產(chǎn)品31的信息，只在resource-URL上使用PUT，而不是集合。
POST /shops：應(yīng)該創(chuàng)建一個(gè)新的商店，并返回創(chuàng)建的新商店的詳細(xì)信息。在集合url上使用POST。