RESTful規範1

RESTful規範

一 什麼是RESTful

REST與技術無關，表明的是一種軟件架構風格，REST是Representational State Transfer的簡稱，中文翻譯爲「表徵狀態轉移」

二 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。

{
        error: "Invalid API key"
    }

• 返回結果，針對不一樣操做，服務器向用戶返回的結果應該符合如下規範。

GET /collection：返回資源對象的列表（數組）
    GET /collection/resource：返回單個資源對象
    POST /collection：返回新生成的資源對象
    PUT /collection/resource：返回完整的資源對象
    PATCH /collection/resource：返回完整的資源對象
    DELETE /collection/resource：返回一個空文檔

• Hypermedia API，RESTful API最好作到Hypermedia，即返回結果中提供連接，連向其餘API方法，使得用戶不查文檔，也知道下一步應該作什麼。

{"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)