REST API註意事項

来源:http://www.cnblogs.com/jonathanzhao/archive/2016/01/28/5165253.html
-Advertisement-
Play Games

RFC一致性 Methods GET: 獲取某個資源,冪等且無副作用。 POST: 創建一個新的資源。 PUT: 替換某個已有的資源。冪等有副作用。 PATCH: 修改某個已有的資源。 DELETE:刪除某個資源。冪等有副作用。 Headers Accept:伺服器需要返回什麼樣的content。


RFC一致性

Methods

GET: 獲取某個資源,冪等且無副作用。

POST: 創建一個新的資源。

PUT: 替換某個已有的資源。冪等有副作用。

PATCH: 修改某個已有的資源。

DELETE:刪除某個資源。冪等有副作用。

Headers

Accept:伺服器需要返回什麼樣的content。

If-Modified-Since/If-None-Match:如果客戶端提供某個條件,那麼當這條件滿足時,才返回數據,否則返回304 not modified。

If-Match:在對某個資源做PUT/PATCH/DELETE操作時,伺服器應該要求客戶端提供If-Match頭,只有客戶端提供的Etag與伺服器對應資源的Etag一致,才進行操作,否則返回412 precondition failed。

返回恰當的Status Code

安全性

一致性,機密性,和可用性

請求數據驗證

Request headers是否合法:如果出現了某些不該有的頭,或者某些必須包含的頭沒有出現或者內容不合法,根據其錯誤類型一律返回4xx。
可以在HTTP頭中增加X-Request-ID標識調用者身份。
示例:

GET /photos/puppy.jpg HTTP/1.1
X-Request-ID: 1pvs6edg31p92bld853plok8b4

Request URI和Request body是否合法:如果請求帶有了不該有的數據,或者某些必須包含的數據沒有出現或內容不合法,一律返回4xx。

數據完整性驗證

數據完整性驗證的底線是:保證要修改的數據和伺服器里的數據是一致的 —— 這是通過Etag來完成。
Etag可以認為是某個資源的一個唯一的版本號。當客戶端請求某個資源時,該資源的Etag一同被返回,而當客戶端需要修改該資源時,需要通過"If-Match"頭來提供這個Etag。
伺服器檢查客戶端提供的Etag是否和伺服器同一資源的Etag相同,如果相同,才進行修改,否則返回412 precondition failed。

訪問控制

REST API需要清晰定義哪些操作能夠公開訪問,哪些操作需要授權訪問。

在HTTP協議之上處理授權有很多方法,如HTTP BASIC Auth,OAuth,HMAC Auth等,其核心思想都是驗證某個請求是由一個合法的請求者發起。

HMAC Auth保證一致性:請求的數據在傳輸過程中未被修改,因此可以安全地用於驗證請求的合法性。
HMAC主要在請求頭中使用兩個欄位:Authorization和Date(或X-Auth-Timestamp)。
Authorization欄位的內容由":"分隔成兩部分,":"前是access-key,":"後是HTTP請求的HMAC值。 在做HMAC的時候,request headers中的request method,request URI,Date/X-Auth-Timestamp等header會被計算在HMAC中。
示例:

GET /photos/puppy.jpg HTTP/1.1
X-Auth-Timestamp: Mon, 26 Mar 2007 19:37:58 +0000
Authorization: AKIAIOSFODNN7EXAMPLE:frJIUN8DYpKDtOLCwo//yllqDzg=

將時間戳計算在HMAC中的好處是可以防止replay攻擊。一個請求攜帶的時間戳,和該請求到達伺服器時伺服器的時間戳,中間差別太大,超過某個閾值(比如說120s),那麼可以認為是replay,伺服器主動丟棄該請求。

需要保證傳輸內容安全,使用HTTPS加密傳輸。

其他

rate limiting:訪問限制。

metrics:伺服器應該收集每個請求的訪問時間,到達時間,處理時間,latency,便於瞭解API的性能和客戶端的訪問分佈,以便更好地優化性能和應對突發請求。

docs:豐富的介面文檔 —— API的調用者需要詳盡的文檔來正確調用API,可以用swagger來實現。

hooks/event propogation:其他系統能夠比較方便地與該API集成。

參考文章:http://kb.cnblogs.com/page/521718/
作者: programmer_life

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 語法 awk [ -F re] [parameter...] ['pattern {action}' ] [-f progfile][in_file...] 獲得普通外部變數 [xingxing.dxx@30_28_6_20 ~]$ test='test code' [xingxing.dxx@30
  • 漢字元在IntelliJ的控制台輸出亂碼。編譯器在編譯的時候,把漢字元編譯成非UTF-8而引起亂碼。我是在做Jsoup解析的時候出現的錯誤,其實歸根結底確實編譯器的原因。 解決方法: 1.修改.idea/encoding.xml。將對應工程的編碼方式(如GBK)改為UTF-8; 2.如果是Maven
  • 1, Swift 修改導航欄顏色 self.navigationController?.navigationBar.barTintColor 2, Swift button 屬性設置時直接進行初始化 var leftButton : UIButton = UIButton(type: UIButto
  • 1、建立DLL動態庫 動態鏈接庫(DLL)是從C語言函數庫和Pascal庫單元的概念發展而來的。所有的C語言標準庫函數都存放在某一函數庫中。在鏈接應用程式的過程中,鏈接器從庫文件中拷貝程式調用的函數代碼,並把這些函數代碼添加到可執行文件中。這種方法同只把函數儲存在已編譯的OBJ文件中相比更有利於代碼
  • 註意:本章代碼將會建立在上一章的代碼基礎上,上一章鏈接《第八章 企業項目開發--分散式緩存memcached》 1、為什麼用Redis 1.1、為什麼用分散式緩存(或者說本地緩存存在的問題)? 見《第八章 企業項目開發--分散式緩存memcached》 1.2、有了memcached,為什麼還要用r
  • 在我的設計模式分類當中,我選擇單例模式作為我第一個要寫的設計模式,其一,單例模式簡單、容易理解讓人接受,其二,單例模式很常用,在實際的Winform窗體應用開發中能夠帶來更好的客戶體驗。 單例模式的核心是在應用程式的生命周期中只實例化一次當前類,讓整個應用整個應用程式中只擁有一個當前類實例化的對象,
  • 一、什麼是生成器模式 對複雜對象的創建過程進行抽象,相同的創建步驟,不一樣的創建過程實現,生成不同表示的對象; 例如創建一臺電腦,對其應用生成器模式進行創建: 創建過程是指創建cpu、創建記憶體、創建顯示器三個步驟,所有品牌電腦的創建過程都是一樣的,可以對其抽象出一個抽象建造者角色Builder; 不
  • 這裡說的緩存只是為了提供一些動態的界面沒辦法作靜態化的界面來減少資料庫的訪問壓力,如果能夠做靜態化的話的還是採用nginx來做界面的靜態化,這樣可以承受高併發的訪問能力。 好了,廢話少說直接看實現代碼吧下載地址, 實現機制主要是通過過濾器攔截方案,有兩個地方要註意的 1,Servlet過慮器中使用S
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...