RESTful設計方法

1. 域名

應該盡量將API部署在專用域名之下。

https://api.example.com

如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下。

https://example.org/api/

2. 版本（Versioning）

應該將API的版本號放入URL。

http://www.example.com/app/1.0/foo

http://www.example.com/app/1.1/foo

http://www.example.com/app/2.0/foo

另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github采用這種做法。

因為不同的版本，可以理解成同一種資源的不同表現形式，所以應該采用同一個URL。版本號可以在HTTP請求頭信息的Accept字段中進行區分（參見Versioning REST Services）：

Accept: vnd.example-com.foo+json; version=1.0

Accept: vnd.example-com.foo+json; version=1.1

Accept: vnd.example-com.foo+json; version=2.0

3. 路徑（Endpoint）

路徑又稱"終點"（endpoint），表示API的具體網址，每個網址代表一種資源（resource）

(1) 資源作為網址，只能有名詞，不能有動詞，而且所用的名詞往往與數據庫的表名對應。

舉例來說，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

對於一個簡潔結構，你應該始終用名詞。 此外，利用的HTTP方法可以分離網址中的資源名稱的操作。

GET /products ：將返回所有產品清單
POST /products ：將產品新建到集合
GET /products/4 ：將獲取產品 4
PATCH（或）PUT /products/4 ：將更新產品 4

(2) API中的名詞應該使用復數。無論子資源或者所有資源。

舉例來說，獲取產品的API可以這樣定義

獲取單個產品：http://127.0.0.1:8080/AppName/rest/products/1
獲取所有產品: http://127.0.0.1:8080/AppName/rest/products

3. HTTP動詞

對於資源的具體操作類型，由HTTP動詞表示。

常用的HTTP動詞有下面四個（括號裏是對應的SQL命令）。

• GET（SELECT）：從服務器取出資源（一項或多項）。
• POST（CREATE）：在服務器新建一個資源。
• PUT（UPDATE）：在服務器更新資源（客戶端提供改變後的完整資源）。
• DELETE（DELETE）：從服務器刪除資源。

還有三個不常用的HTTP動詞。

• PATCH（UPDATE）：在服務器更新(更新)資源（客戶端提供改變的屬性）。
• HEAD：獲取資源的元數據。
• OPTIONS：獲取信息，關於資源的哪些屬性是客戶端可以改變的。

下面是一些例子。

GET /zoos：列出所有動物園
POST /zoos：新建一個動物園（上傳文件）
GET /zoos/ID：獲取某個指定動物園的信息
PUT /zoos/ID：更新某個指定動物園的信息（提供該動物園的全部信息）
PATCH /zoos/ID：更新某個指定動物園的信息（提供該動物園的部分信息）
DELETE /zoos/ID：刪除某個動物園
GET /zoos/ID/animals：列出某個指定動物園的所有動物
DELETE /zoos/ID/animals/ID：刪除某個指定動物園的指定動物

4. 過濾信息（Filtering）

如果記錄數量很多，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。

下面是一些常見的參數。

?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件

參數的設計允許存在冗余，即允許API路徑和URL參數偶爾有重復。比如，GET /zoos/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

6. 狀態碼（Status Codes）

服務器向用戶返回的狀態碼和提示信息，常見的有以下一些（方括號中是該狀態碼對應的HTTP動詞）。

• 200 OK - [GET]：服務器成功返回用戶請求的數據
• 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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。

狀態碼的完全列表參見

https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

7. 錯誤處理（Error handling）

如果狀態碼是4xx，服務器就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。

{
    error: "Invalid API key"
}

8. 返回結果

針對不同操作，服務器向用戶返回的結果應該符合以下規範。

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

9. 超媒體（Hypermedia API）

RESTful API最好做到Hypermedia（即返回結果中提供鏈接，連向其他API方法），使得用戶不查文檔，也知道下一步應該做什麽。

比如，Github的API就是這種設計，訪問api.github.com會得到一個所有可用API的網址列表。

{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}

從上面可以看到，如果想獲取當前用戶的信息，應該去訪問api.github.com/user，然後就得到了下面結果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

上面代碼表示，服務器給出了提示信息，以及文檔的網址。

10. 其他

服務器返回的數據格式，應該盡量使用JSON，避免使用XML。

urlpatterns = {
    url(r‘^index/$‘, views.index),
    url(r‘^books/$‘, views.BooksAPIView.as_view()),
    url(r‘^books/(?P<pk>\d+)/$‘, views.BookAPIView.as_view()),
    url(r‘^heros/$‘, views.HerosAPIView.as_view()),
    url(r‘^heros/(?P<pk>\d+)/$‘, views.HeroAPIView.as_view()),
}

demo：

django中的restframework風格的API接口的簡單實現；

import json

from django.forms import model_to_dict
from django.http import JsonResponse

from django.shortcuts import HttpResponse
from django.views import View

from app001.models import BookInfo
from app001.models import HeroInfo


def index(request):
    return HttpResponse("ok")


class BooksAPIView(View):
    def get(self, request):
        """
        查詢所有圖書
        :param request:
        :return:
        """
        queryset = BookInfo.objects.all().values()
        book_list = []
        book_list = list(queryset)

        return JsonResponse(book_list, safe=False)

    def post(self, request):
        """
        新增圖書
        :param request:
        :return:
        """
        json_bytes = request.body
        json_str = json_bytes.decode()
        book_dict = json.loads(json_str)

        # book = BookInfo.objects.create(
        #     btitle = book_dict.get("btitle"),
        #     bpub_date = datetime.strptime(book_dict.get("bpub_date"),‘%Y-%m-%d‘).date(),
        # )
        book = BookInfo.objects.create(
            **book_dict
        )

        return JsonResponse({
            "id": book.id,
            "btitle": book.btitle,
            ‘bpub_date‘: book.bpub_date,
            ‘bread‘: book.bread,
            ‘bcomment‘: book.bcomment,
            # ‘image‘: book.image.url if book.image else ‘‘
        }, status=201)


class BookAPIView(View):
    """
    獲取單個圖書的信息
    """

    def get(self, request, pk):
        try:
            book = BookInfo.objects.get(id=pk)
        except Exception as e:
            print(e)
            return HttpResponse(status=404)

        book_dict = model_to_dict(book)
        return JsonResponse(book_dict)

    def put(self, request, pk):
        """
        修改圖書信息
        :param request:
        :param pk:
        :return:
        """
        try:
            book = BookInfo.objects.get(id=pk)
        except Exception as e:
            print(e)
            return HttpResponse(status=404)

        # 校驗參數

        json_bytes = request.body
        json_str = json_bytes.decode()
        book_dict = json.loads(json_str)

        BookInfo.objects.filter(id=pk).update(**book_dict)
        # from django.forms.models import model_to_dict
        book_dict = model_to_dict(BookInfo.objects.get(id=pk))
        return JsonResponse(book_dict)

    def delete(self, request, pk):
        """
        刪除
        :param request:
        :param pk:
        :return:
        """
        try:
            book = BookInfo.objects.get(id=pk)
        except Exception as e:
            print(e)
            return HttpResponse(status=404)

        book.delete()
        return HttpResponse(status=204)


class HerosAPIView(View):
    def get(self, request):
        hero = HeroInfo.objects.all().values()
        hero = list(hero)
        return JsonResponse(hero, safe=False)

    def post(self, request):
        json_bytes = request.body
        json_str = json_bytes.decode()
        hero_dict = json.loads(json_str)
        hero = ""
        try:
            hero = HeroInfo.objects.create(**hero_dict)
        except Exception as e:
            print(e)
            return HttpResponse(status=404)

        return JsonResponse(model_to_dict(hero), status=201)


class HeroAPIView(View):
    def get(self, request, pk):
        hero = HeroInfo.objects.get(id=pk)
        return JsonResponse(model_to_dict(hero))

    def put(self, request, pk):
        """
        修改圖書
        :param request:
        :param pk:
        :return:
        """
        try:
            hero = HeroInfo.objects.get(id=pk)
        except Exception as e:
            print(e)
            return HttpResponse(status=404)

        json_bytes = request.body
        json_str = json_bytes.decode()
        json_dict = json.loads(json_str)

        hero = HeroInfo.objects.filter(id=pk).update(**json_dict)
        hero_dict = model_to_dict(HeroInfo.objects.get(id=pk))
        return JsonResponse(hero_dict)

    def delete(self, request, pk):
        try:
            hero = HeroInfo.objects.get(id=pk)
        except Exception as e:
            print(e)
            return HttpResponse(status=404)
        hero.delete()
        return HttpResponse(status=204)

Django REST framework API開發