0801 RESTAPI設計，DRF 序列化
1.內容回顧
1.restframework serializer(序列化)的簡單使用
QuereySet([obj,obj,obj]) --> JSON格式數據
安裝和導入：
pip install djangorestframework
from rest_framework import serializer
1.創建一個類，類一定要繼承serializer.Serializers
2.chocie字段和FK字段都可以通過source來獲取對應的值
3.多對多字段可以通過使用serializer.SerializerMethod
聲明序列化器：
def get_tag(self, obj):
tag_list = []
for i in obj.tag.all():
tag_list.append(i.name)
return tag_list
2.使用 ModelSerializer
通過配置class Meta:
model = 表名
fields = [‘字段‘, ...]
depth = 1
2. 今日內容
1. RESTful風格API介紹
一、什麽是RESTful
REST -- REpresentational State Transfer，英語的直譯就是“表現層狀態轉移”。如果看這個概念，估計沒幾個人能明白是什麽意思。
那下面就讓我來用一句人話解釋一下什麽是RESTful:URL定位資源，用HTTP動詞（GET,POST,PUT,DELETE)描述操作。
Resource：資源，即數據。
Representational：某種表現形式，比如用JSON，XML，JPEG等；
State Transfer：狀態變化。通過HTTP動詞實現。
REST與技術無關，代表的是一種軟件架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表征狀態轉移”。
REST從資源得角度類審視整個網絡，它將分布在網絡中某個節點的資源通過URL進行標識，客戶端應用通過URL來獲取資源的表征，獲得這些表征致使這些應用轉變狀態。
所有的數據，不過是通過網絡獲取的還是操作（增刪改查）的數據，都是資源，將一切數據視為資源是REST區別與其他架構風格的最本質屬性。
二、RESTful API設計
API與用戶的通信協議
總是使用HTTPs協議。
域名
https://api.example.com 盡量將API部署在專用域名
https://example.org/api/ 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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。
更多看這裏：http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
錯誤處理
狀態碼是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"
}}
2. from rest_framework import APIView
class Comment(views.View):
pass
-------- 之前的寫法 ↑ ----------
class APIView(views.View)：
擴展的功能
self.request = Resquest(
self._request = request(Django的request)
)
self.request.data 封裝好的數據屬性，POST\PUT請求攜帶的數據都可以從這裏取
pass
class Comment(APIView):
pass
3. serializer
1. ModelSerializer
1. 基於APIView實現的GET和POST
2. POST過來的數據進行校驗
3. 保存數據
2. 超鏈接的URL
0801 RESTAPI設計，DRF 序列化