Restful api

符合REST架構設計的API叫做restful api。
那麼什麼是REST呢？REST是所有Web應用都應該遵守的架構設計指導原則。
Representational State Transfer，翻譯是”表現層狀態轉化”。
面向資源是REST最明顯的特徵，對於同一個資源的一組不同的操作。資源是伺服器上一個可命名的抽象概念，資源是以名詞為核心來組織的，首先關注的是名詞。REST要求，必須通過統一的介面來對資源執行各種操作。對於每個資源只能執行一組有限的操作。（7個HTTP方法：GET/POST/PUT/DELETE/PATCH/HEAD/OPTIONS）

其實說到底，restful api 就是一種統一規範的api設計風格

範例

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：刪除某個指定動物園的指定動物
 

Django Rest framework

- 建立 Models
- 依靠 Serialiers 將資料庫取出的資料 Parse 為 API 的資料（可用於返回給客戶端，也可用於瀏覽器顯示）
- ViewSet 是一個 views 的集合，根據客戶端的請求（GET、POST等），返回 Serialiers 處理的資料許可權 Premissions 也在這一步做處理
- ViewSet 可在 Routers 進行註冊，註冊後會顯示在 Api Root 頁上
- 在 urls 裡註冊 ViewSet 生成的 view，指定監聽的 url

# 以rmdb 的idc為例，來寫一個簡單的restful api
 

# 這是models.py 
class Idc(models.Model):
    ch_name = models.CharField("機房中文名稱", max_length=32, unique=True, null=True)
    en_name = models.CharField("機房英文名稱", max_length=32, unique=True, null=True)
    address = models.CharField("機房地址", max_length=100, null=True, blank=True)
    ip_range = models.CharField("IP範圍", max_length=64, null=True)
    bandwidth = models.CharField("接入頻寬", max_length=32, null=True)
    add_person = models.CharField("新增人", max_length=50, null=True)
    add_time = models.CharField("新增時間", max_length=50, null=True)
    description = models.TextField("備註", max_length=100, null=True, blank=True)

    def __str__(self):
        return self.en_name

    class Meta:
        verbose_name = '機房'
        verbose_name_plural = '機房'
########################################################
# 然後寫序列化檔案
# serializers.py
from rmdb.models import *
from rest_framework import serializers


class IdcSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Idc
        fields = '__all__'
        # fields = ('id','ch_name','en_name','address','bandwidth','description')

#########################################################
# 再寫view檔案
# view.py
from rmdb.models import *
from rest_framework import viewsets
from rest_framework import permissions
from restapi.serializers import IdcSerializer

class IdcViewSet(viewsets.ModelViewSet):
    queryset = Idc.objects.all().order_by('-add_time')
    serializer_class = IdcSerializer
    permission_classes = (permissions.IsAuthenticated,)

#########################################################
# 最後寫url檔案
# urls.py
from django.conf.urls import include, url
from rest_framework import routers
from restapi.views import IdcViewSet

router = routers.DefaultRouter()
router.register(r'idc', IdcViewSet)

urlpatterns = [
    url(r'^', include(router.urls)),
]

## 然後就可以用瀏覽器或者命令列訪問測試了，一個簡單的restful api就完成了。