RESTful規範 RESTful API介紹
RESTful API介紹
RESTful介紹
REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”或“表現層狀態轉化”。
推薦閱讀 阮一峰 理解RESTful架構
RESTful API設計指南
推薦閱讀 阮一峰 RESTful設計指南
API與使用者的通訊協議
總是使用HTTPs協議
域名
https://api.example.com
https://example.org/api/
版本
1. 將版本資訊放在URL中，如：https://api.example.com/v1/
2. 將版本資訊放在請求頭中。
路徑
視網路上任何東西都是資源，均使用名詞表示（可複數）
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 - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。
錯誤處理
狀態碼是4xx時，應返回錯誤資訊，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"
}}
基於Django實現RESTful API
路由
urlpatterns = [
url(r'^users', Users.as_view()),
]
檢視
from django.views import View
from django.http import JsonResponse
class Users(View):
def get(self, request, *args, **kwargs):
result = {
'code': 0,
'data': 'response data'
}
return JsonResponse(result, status=200)
def post(self, request, *args, **kwargs):
result = {
'code': 0,
'data': 'response data'
}
return JsonResponse(result, status=200)
基於Django REST Framework框架實現
路由
from django.conf.urls import url, include
from web.views.s1_api import TestView
urlpatterns = [
url(r'^test/', TestView.as_view()),
]
檢視
from rest_framework.views import APIView
from rest_framework.response import Response
class TestView(APIView):
def dispatch(self, request, *args, **kwargs):
"""
請求到來之後，都要執行dispatch方法，dispatch方法根據請求方式不同觸發 get/post/put等方法
注意：APIView中的dispatch方法有好多好多的功能
"""
return super().dispatch(request, *args, **kwargs)
def get(self, request, *args, **kwargs):
return Response('GET請求，響應內容')
def post(self, request, *args, **kwargs):
return Response('POST請求，響應內容')
def put(self, request, *args, **kwargs):
return Response('PUT請求，響應內容')
上述就是使用Django REST framework框架搭建API的基本流程，重要的功能是在APIView的dispatch中觸發。
RESTful介紹
REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”或“表現層狀態轉化”。
推薦閱讀 阮一峰 理解RESTful架構
RESTful API設計指南
推薦閱讀 阮一峰 RESTful設計指南
API與使用者的通訊協議
總是使用HTTPs協議
域名
https://api.example.com
https://example.org/api/
版本
1. 將版本資訊放在URL中，如：https://api.example.com/v1/
2. 將版本資訊放在請求頭中。
路徑
視網路上任何東西都是資源，均使用名詞表示（可複數）
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 - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。
錯誤處理
狀態碼是4xx時，應返回錯誤資訊，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"
}}
基於Django實現RESTful API
路由
urlpatterns = [
url(r'^users', Users.as_view()),
]
檢視
from django.views import View
from django.http import JsonResponse
class Users(View):
def get(self, request, *args, **kwargs):
result = {
'code': 0,
'data': 'response data'
}
return JsonResponse(result, status=200)
def post(self, request, *args, **kwargs):
result = {
'code': 0,
'data': 'response data'
}
return JsonResponse(result, status=200)
基於Django REST Framework框架實現
路由
from django.conf.urls import url, include
from web.views.s1_api import TestView
urlpatterns = [
url(r'^test/', TestView.as_view()),
]
檢視
from rest_framework.views import APIView
from rest_framework.response import Response
class TestView(APIView):
def dispatch(self, request, *args, **kwargs):
"""
請求到來之後，都要執行dispatch方法，dispatch方法根據請求方式不同觸發 get/post/put等方法
注意：APIView中的dispatch方法有好多好多的功能
"""
return super().dispatch(request, *args, **kwargs)
def get(self, request, *args, **kwargs):
return Response('GET請求，響應內容')
def post(self, request, *args, **kwargs):
return Response('POST請求，響應內容')
def put(self, request, *args, **kwargs):
return Response('PUT請求，響應內容')
上述就是使用Django REST framework框架搭建API的基本流程，重要的功能是在APIView的dispatch中觸發。