2. 程式人生 > >RESTful規範 RESTful規範

RESTful規範 RESTful規範

阿新 • • 發佈：2018-12-16

RESTful規範

本文目錄 回到目錄

一 什麼是RESTful

  • REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”
  • REST從資源的角度類審視整個網路，它將分佈在網路中某個節點的資源通過URL進行標識，客戶端應用通過URL來獲取資源的表徵，獲得這些表徵致使這些應用轉變狀態
  • REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”
  • 所有的資料，不過是通過網路獲取的還是操作（增刪改查）的資料，都是資源，將一切資料視為資源是REST區別與其他架構風格的最本質屬性
  • 對於REST這種面向資源的架構風格，有人提出一種全新的結構理念，即：面向資源架構（ROA：Resource Oriented Architecture）
回到目錄

二  RESTful API設計

  • API與使用者的通訊協議，總是使用
    HTTPs協議    。
  • 域名 
    • https://api.example.com                         儘量將API部署在專用域名（會存在跨域問題）
    • https://example.org/api/                        API很簡單
  • 版本
    • URL，如：https://api.example.com/v1/
    • 請求頭                                                  跨域時，引發傳送多次請求
  • 路徑，視網路上任何東西都是資源，均使用名詞表示（可複數）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees
  • method
    • GET      ：從伺服器取出資源（一項或多項）
    • POST    ：在伺服器新建一個資源
    • PUT      ：在伺服器更新資源（客戶端提供改變後的完整資源）
    • PATCH  ：在伺服器更新資源（客戶端提供改變的屬性）
    • DELETE ：從伺服器刪除資源
  • 過濾，通過在url上傳參的形式傳遞搜尋條件
    • https://api.example.com/v1/zoos?limit=10：指定返回記錄的數量
    • https://api.example.com/v1/zoos?offset=10：指定返回記錄的開始位置
    • https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁，以及每頁的記錄數
    • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序
    • https://api.example.com/v1/zoos?animal_type_id=1：指定篩選條件
  • 狀態碼
    複製程式碼 
    200 OK - [GET]：伺服器成功返回使用者請求的資料，該操作是冪等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：使用者新建或修改資料成功。
202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）
204 NO CONTENT - [DELETE]：使用者刪除資料成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤，伺服器沒有進行新建或修改資料的操作，該操作是冪等的。
401 Unauthorized - [*]：表示使用者沒有許可權（令牌、使用者名稱、密碼錯誤）。 403 Forbidden - [*] 表示使用者得到授權（與401錯誤相對），但是訪問是被禁止的。 404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄，伺服器沒有進行操作，該操作是冪等的。 406 Not Acceptable - [GET]：使用者請求的格式不可得（比如使用者請求JSON格式，但是隻有XML格式）。 410 Gone -[GET]：使用者請求的資源被永久刪除，且不會再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時，發生一個驗證錯誤。 500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。 更多看這裡：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
    複製程式碼
  • 錯誤處理，應返回錯誤資訊，error當做key。
    1 2 3 {      error: "Invalid API key" }
  • 返回結果，針對不同操作，伺服器向用戶返回的結果應該符合以下規範。
    1 2 3 4 5 6 GET / collection：返回資源物件的列表（陣列） GET / collection / resource：返回單個資源物件 POST / collection：返回新生成的資源物件 PUT / collection / resource：返回完整的資源物件 PATCH / collection / resource：返回完整的資源物件 DELETE / collection / resource：返回一個空文件
  • Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼。
    1 2 3 4 5 6 { "link" : {    "rel" :   "collection https://www.example.com/zoos" ,    "href" :  "https://api.example.com/zoos" ,    "title" : "List of zoos" ,    "type" :  "application/vnd.yourformat+json" }}

　　摘自：http://www.ruanyifeng.com/blog/2014/05/restful_api.html

回到目錄

三 基於Django實現

路由系統：

urlpatterns = [
    url(r'^users/$', views.Users.as_view()),
    url(r'^users2/$', views.user2),

]

檢視函式：

複製程式碼 
import json

def  user2(request):
    if request.method=='GET':
        dic = {'status':200,'name': 'lqz2', 'age': 18}
        return HttpResponse(json.dumps(dic))
    elif request.method=='POST':
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)

class Users(View):
    def get(self, request):
        dic = {'status':200,'name': 'lqz', 'age': 18}
        return HttpResponse(json.dumps(dic))

    def post(self, request):
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)
複製程式碼

 

回到目錄

一 什麼是RESTful

  • REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”
  • REST從資源的角度類審視整個網路，它將分佈在網路中某個節點的資源通過URL進行標識，客戶端應用通過URL來獲取資源的表徵，獲得這些表徵致使這些應用轉變狀態
  • REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”
  • 所有的資料，不過是通過網路獲取的還是操作（增刪改查）的資料，都是資源，將一切資料視為資源是REST區別與其他架構風格的最本質屬性
  • 對於REST這種面向資源的架構風格，有人提出一種全新的結構理念，即：面向資源架構（ROA：Resource Oriented Architecture）
回到目錄

二  RESTful API設計

  • API與使用者的通訊協議，總是使用HTTPs協議。
  • 域名 
    • https://api.example.com                         儘量將API部署在專用域名（會存在跨域問題）
    • https://example.org/api/                        API很簡單
  • 版本
    • URL，如：https://api.example.com/v1/
    • 請求頭                                                  跨域時，引發傳送多次請求
  • 路徑，視網路上任何東西都是資源，均使用名詞表示（可複數）
    • https://api.example.com/v1/zoos
    • https://api.example.com/v1/animals
    • https://api.example.com/v1/employees
  • method
    • GET      ：從伺服器取出資源（一項或多項）
    • POST    ：在伺服器新建一個資源
    • PUT      ：在伺服器更新資源（客戶端提供改變後的完整資源）
    • PATCH  ：在伺服器更新資源（客戶端提供改變的屬性）
    • DELETE ：從伺服器刪除資源
  • 過濾，通過在url上傳參的形式傳遞搜尋條件
    • https://api.example.com/v1/zoos?limit=10：指定返回記錄的數量
    • https://api.example.com/v1/zoos?offset=10：指定返回記錄的開始位置
    • https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁，以及每頁的記錄數
    • https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序
    • https://api.example.com/v1/zoos?animal_type_id=1：指定篩選條件
  • 狀態碼
    複製程式碼 
    200 OK - [GET]：伺服器成功返回使用者請求的資料，該操作是冪等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：使用者新建或修改資料成功。
202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）
204 NO CONTENT - [DELETE]：使用者刪除資料成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤，伺服器沒有進行新建或修改資料的操作，該操作是冪等的。
401 Unauthorized - [*]：表示使用者沒有許可權（令牌、使用者名稱、密碼錯誤）。 403 Forbidden - [*] 表示使用者得到授權（與401錯誤相對），但是訪問是被禁止的。 404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄，伺服器沒有進行操作，該操作是冪等的。 406 Not Acceptable - [GET]：使用者請求的格式不可得（比如使用者請求JSON格式，但是隻有XML格式）。 410 Gone -[GET]：使用者請求的資源被永久刪除，且不會再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時，發生一個驗證錯誤。 500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。 更多看這裡：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
    複製程式碼
  • 錯誤處理，應返回錯誤資訊，error當做key。
    1 2 3 {      error: "Invalid API key" }
  • 返回結果，針對不同操作，伺服器向用戶返回的結果應該符合以下規範。
    1 2 3 4 5 6 GET / collection：返回資源物件的列表（陣列） GET / collection / resource：返回單個資源物件 POST / collection：返回新生成的資源物件 PUT / collection / resource：返回完整的資源物件 PATCH / collection / resource：返回完整的資源物件 DELETE / collection / resource：返回一個空文件
  • Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼。
    1 2 3 4 5 6 { "link" : {    "rel" :   "collection https://www.example.com/zoos" ,    "href" :  "https://api.example.com/zoos" ,    "title" : "List of zoos" ,    "type" :  "application/vnd.yourformat+json" }}

　　摘自：http://www.ruanyifeng.com/blog/2014/05/restful_api.html

回到目錄

三 基於Django實現

路由系統：

urlpatterns = [
    url(r'^users/$', views.Users.as_view()),
    url(r'^users2/$', views.user2),

]

檢視函式：

複製程式碼 
import json

def  user2(request):
    if request.method=='GET':
        dic = {'status':200,'name': 'lqz2', 'age': 18}
        return HttpResponse(json.dumps(dic))
    elif request.method=='POST':
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)

class Users(View):
    def get(self, request):
        dic = {'status':200,'name': 'lqz', 'age': 18}
        return HttpResponse(json.dumps(dic))

    def post(self, request):
        dic = {'status': 200, 'msg': '修改成功'}
        return JsonResponse(dic)
複製程式碼

 

相關推薦

API設計規範 ----Restful

creat cif created 排序 href use 服務 如果 pat 　　 Restful API設計指南 接下來我將介紹RESTful API的設計細節，探討如何設計一套合理、好用的API 一、協議 API與用戶的通信協議，總是使用HTTPs協議。

Python Restful API設計規範

探討 資源 表現層 gin htm 異步任務 sci 在服務器 type Python 之路，Restful API設計規範 理解RESTful架構 Restful API設計指南 理解RESTful架構 越來越多的人開始意識到，網站即軟件

RESTful API設計規範收集

版本控制 執行 tap cep 冪等性 解耦 sdn hyperlink radi 說明：其實沒有絕對的規範，達到90%即可。 理解RESTful架構：http://www.ruanyifeng.com/blog/2011/09/restful.html RESTful

Restful接口規範

auth type 實體 基本 實現 AD lec 通用 風格 模型表示（Representations） 消息（Messages） URIs 一致接口（Uniform interface） 無狀態（Stateless） 資源之間的鏈接（Links between res

Restful API設計規範

理解RESTful架構 Restful API設計指南     理解RESTful架構 越來越多的人開始意識到，網站即軟體，而且是一種新型的軟體。 這種"網際網路軟體"採用客戶端/伺服器模式，建立在分散式體系上，通過網際網路通訊，具有高延時（high latency）、高併發等

RESTful規範 RESTful

  REST風格  -- 資源 網頁中能看到的都是資源  -- URI  統一資源識別符號     URL  統一資源定位符  -- 統一資源介面  &nbs

CHENGDU3-Restful API 介面規範、django-rest-framework框架

  Restful API 介面規範、django-rest-framework框架 問題：什麼是API? 答：API是介面，提供url. 介面有兩個用途： 為別人提供服務，前後端分離。 為什麼使用前後端分離？ 答：主要為了資料的解耦，提高開發效率。 如果更新了資料，

從 Feign 使用注意點到 RESTFUL 介面設計規範

最近專案中大量使用了Spring Cloud Feign來對接http介面，踩了不少坑，也產生了一些對RESTFUL介面設計的想法，特此一篇記錄下。 SpringMVC的請求引數繫結機制 瞭解Feign歷史的朋友會知道，Feign本身是Netflix的產品，Spring C

RESTful規範 RESTful規範

RESTful規範 本文目錄 一 什麼是RESTful 二  RESTful API設計 三 基於Django實現 回到目錄 一 什麼是RES

【RESTful】RESTful API 設計規範

概念 本質：一種軟體架構風格 核心：面向資源設計的API 解決問題： 降低開發的複雜性 提高系統的可伸縮性 例如：設計一套API，為多個終端服務。 設計概念和準則 網路上的所有事物都可以被抽象為資源 每一個資源都有唯一的資源標識，對資源的操作不會改變這些標

Restful API設計規範學習筆記

1 api專有域名/或在專案中建立API專用目錄 2 URL中加入版本號 v1,v2(專案小可以不加) 3 資源名用名詞     eg：http://api.douban.com/v2/movie/ 名詞：movie，user... 4 記錄很多時，URL加引數進行

RESTful風格的規範和url設計

RESTful規範：GET：查詢操作POST：修改/新增操作PUT：新增操作DELETE：刪除操作RESTful url設計：user/{uid}/friends  //使用者/使用者id/使用者的朋友，表示使用者的好友列表，語義清晰明瞭，符合RESTful風格user/fr

RESTful API 編寫規範

RESTful API 編寫規範 在一個RESTful系統裡，客戶端向服務端發起索取資源的操作只能通過HTTP協議語義來進行互動。最常用的HTTP協議語義有以下5個： GET GET:傳送一條或者多條GET請求都不會改變伺服器裡面的資源，同一個request發一遍和發

RESTful api介面規範

整體規範建議採用RESTful 方式來實施。 協議 API與使用者的通訊協議，總是使用HTTPs協議，確保互動資料的傳輸安全。 域名 應該儘量將API部署在專用域名之下。 https://api.example.com 如果確定API很簡單，不會有進一步擴充套件，可以考

RESTful規範 RESTful API介紹

  RESTful API介紹  

【RESTful】RESTful API 介面設計規範 | 示例

概念 本質：一種軟體架構風格 核心：面向資源設計的API 解決問題： 降低開發的複雜性 提高系統的可伸縮性 例如：設計一套API，為多個終端服務。 設計概念和準則 網路上的所有事物都可以被抽象為資源 每一個資源都有唯一的資源標識，

微服務RESTful 介面設計規範

1、RESTful發展背景及簡介 網路應用程式，分為前端和後端兩個部分。當前的發展趨勢，就是前端裝置層出不窮（手機、平板、桌面電腦、其他專用裝置......）。因此，必須有一種統一的機制，方便不同的前端裝置與後端進行通訊。這導致API構架的流行，甚至出現"APIFirst"的設計思想。RESTf

團隊RESTful 風格API規範

實際上就是用RESTful風格來包裝HTTP協議，並用json或xml格式實現資料互動。 RESTful風格: 網路資源實體化，CURD對資源進行操作。 好的規範評判標準：直觀、擴充套件、優

restful介面設計規範總結

這篇 文章主要是借鑑他人，但是自己很想總結出一套規範 一、重要概念： REST,即Representational State Transfer的縮寫。我對這個片語的翻譯是"表現層狀態轉化"。 Resource（資源） ：物件的單個例項。 例如，一隻動物。它可以是一段文字、一張圖片、一首

理解 RESTful API 設計規範

RESTful是目前最流行的API設計規範，它是用於Web資料介面的設計。從字面可以看出，他是Rest式的介面，所以我們先了解下什麼是Rest。 REST與技術無關，它代表的是一種軟體架構風格，REST它是 Representational State Transfer的簡稱，中文的含義是: "表徵狀態轉移