restful接口規范 | 基於restful的原生django接口

restful接口規范

接口

接口：聯系兩個物質的媒介，完成信息交互
web程序中：聯系前台頁面與后台數據庫的媒介
web接口組成：
    - url：長得像返回數據的url鏈接
    - 請求參數：前台按照指定的key提供數據給后台
    - 響應數據：后台與數據庫交互后將數據反饋給前台

 

規范

web數據請求接口設計規范

# 分兩部分
1. url: 1）通常使用https請求
2）域名：有api關鍵字出現
    -- https://api.example.com  (存在跨域問題)
    -- https://example.com/api
3）版本：不同版本需要標注
    -- https://example.com/api/v1 | -- https://example.com/api/1
    -- https://example.com/api/v2 | -- https://example.com/api/2
4）資源：請求的目標數據稱之為資源，資源一般都有名詞復數表示
    -- https://example.com/api/v1/books  (之前不規范的案例: /get_books/)
5）操作方式：不從請求鏈接體現操作方式，從請求方式上決定操作方式(一條url對應get或post等多種操作,所以后端采用CBV)
    -- get：https://example.com/api/v1/books  獲取所有
    -- post：https://example.com/api/v1/books  新增一本
    -- put：https://example.com/api/v1/book/1  更新id=1的一本(整體更新)
    -- patch：https://example.com/api/v1/book/1  更新id=1的一本(局部更新)
    -- delete：https://example.com/api/v1/book/1  刪除id=1的一本
6）資源過濾：通過接口傳遞參數來過濾資源 - 篩選、排序、限制
    -- https://example.com/api/v1/books?limit=10  限制10條
2.響應部分: 7）狀態碼：返回數據要標准狀態碼，通過在數據中 {"status": 200}
    -- SUCCESS("0", "查詢成功")
    -- NODATA("1xx", "非正確，無數據，顯示基本信息")
    -- FEAILED("2xx", "查詢失敗")
8）錯誤信息：請求失敗需要標注錯誤信息  {"message": "請求參數不合法"}
9）操作結果：請求操作成功的返回結果 {"results": []}
    -- get：返回資源列表 | 返回單一資源
    -- post：返回單一新增資源
    -- put：返回更新的資源
    -- patch：返回更新的資源
    -- delete：返回空文檔
10）子資源返回資源接口：返回的資源如果有子資源，返回子資源的鏈接地址，如查找書，書的封面圖片就可以url表示

 

基於restful規范的原生django接口

主路由: url.py

from django.conf.urls import url,include
from django.contrib import admin
​
urlpatterns = [
    url(r'^admin/', admin.site.urls),
# 路由分發
    url(r'^api/',include('api.urls')),
]

 

api應用的子路由: api/url.py

from django.conf.urls import url
​
from . import views
urlpatterns = [
    # get查所有,post添加數據
    url(r'^books/$', views.Book.as_view()),
    # 查一個,刪一個,更新(整體,局部)一個
    url(r'^books/(?P<pk>.*)/', views.Book.as_view())
]

 

模型層: model.py

from django.db import models
​
# Create your models here.
class Book(models.Model):
    title = models.CharField(max_length=64)
    price = models.DecimalField(max_digits=5, decimal_places=2)
​
    class Meta:
        # 表名
        db_table = 'red_book'
        verbose_name = '書籍'
        verbose_name_plural = verbose_name
​
    def __str__(self):
        return self.title

 

后台: admin.py

from django.contrib import admin
​
from . import models
​
admin.site.register(models.Book)

 

數據庫遷移

>: python manage.py makemigrations
>: python manage.py migrrate
​
>: python manage.py createsuperuser

 

視圖層: views.py

from django.http import JsonResponse
​
from django.views import View
from . import models
​
​
class Book(View):
    # View 源碼中判斷wsgiref處理好的request中的請求方式,是GET,還是POST等,並自動掉對應的函數方法(通過調度(dispatch)分發請求)
    def get(self, request, *args, **kwargs):
        # GRT請求時,url后拼接的數據放到了request.GET中
        print(request.GET)
        print(kwargs)  # 有名分組的數據被放到kwargs中
        pk = kwargs.get('pk')
        if not pk:  # 群查
            book_obj_list = models.Book.objects.all()
            # 數據信息列表
            book_list = []
            for obj in book_obj_list:
                dic = {}
                dic['title'] = obj.title
                dic['price'] = obj.price
                book_list.append(dic)
            # 響應數據(遵循接口規范:響應狀態碼, 提示信息, 操作結果)
            return JsonResponse({
                'status': 0,  # 響應狀態碼
                'msg': 'ok',  # 提示信息
                'results': book_list  # 操作結果
            }, json_dumps_params={'ensure_ascii': False})
        else:  # 單查
            book_dic = models.Book.objects.filter(pk=pk).values('title', 'price').first()
            print(book_dic,type(book_dic))
            if book_dic:
                return JsonResponse({
                    'status': 0,
                    'msg': 'ok',
                    'results': book_dic
                }, json_dumps_params={'ensure_ascii': False})
            return JsonResponse({
                    'status': 0,
                    'msg': '無結果',
                }, json_dumps_params={'ensure_ascii': False})
​
    def post(self, request, *args, **kwargs):
        print(request.POST)
        # print(request.POST.dict())
        # print(request.body)
        print(request.FILES)
        # POST請求時的Content-Type有三種:urlencoded,json,formdata
        # urlencoded:將request.body中的二進制數據處理放到對應的request.GET或request.POST中
        # json:數據以二進制形式存放在request.body中不進行處理
        try:
            book_obj = models.Book.objects.create(**request.POST.dict())
            print(book_obj, type(book_obj))
            if book_obj:
                return JsonResponse({
                    'status': 0,
                    'msg': 'ok',
                    'results': {'title':book_obj.title, 'price':book_obj.price}
                }, json_dumps_params={'ensure_ascii':False})
        except:
            return JsonResponse({
                'status': 1,
                'msg': '參數有誤',
            }, json_dumps_params={'ensure_ascii': False})
​
        return JsonResponse({
            'status': 2,
            'msg': '新增失敗',
        }, json_dumps_params={'ensure_ascii': False})
 補充:
    # postman可以完成不同方式的請求：get | post | put ...
    # postman發送數據包有三種方式：form-data | urlencoding | json
    # 原生django對urlencoding方式數據兼容最好

 

​