使用Django開發簡單接口：文章增刪改查

時間 2019-12-06

原文原文鏈接

目錄python

一、一些準備工做

安裝django

pip install django

建立django項目

進入項目代碼存放目錄執行命令：算法

django-admin.py startproject blog_demo

進入blog_demo，運行命令：django

python3.6 manage.py runserver 9000

在瀏覽器地址欄打開：http://127.0.0.1:9000/ 若是出現如下畫面，則說明服務器正在運行
json

建立博客應用（app）

django中每個app能夠看做是一個模塊，以app爲單位，結構清晰，方便管理。api

python3.6 manage.py startapp blog_api

使用開發工具打開項目blog_demo，其結構以下：
瀏覽器

二、models.py

編寫模型層代碼，如下語句至關於建立了兩張表：User，Article安全

class User(models.Model):
    id = models.AutoField(primary_key=True)
    uname = models.CharField(max_length=50)
    upwd = models.CharField(max_length=100)
    #active inactive
    status = models.CharField(max_length=10)

class Article(models.Model):
    id = models.AutoField(primary_key=True)
    title = models.CharField(max_length=50)
    content = models.TextField()
    #deleted alive
    status = models.CharField(max_length=10)

建立表結構：服務器

python3.6  manage.py migrate

settings.py文件INSTALLED_APPS處新增app：blog_apisession

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'blog_api'
]

讓django知道模型有了變化：app

python3.6 manage.py makemigrations blog_api

再次建立表結構：

python3.6  manage.py migrate

三、django admin

登陸

在瀏覽器控制檯輸入：http://127.0.0.1:9000/admin/login/?next=/admin/

建立超級用戶

stephen@stephen-K55VD:~/IdeaProjects/blog_demo$ python3.6 manage.py  createsuperuser 
Username (leave blank to use 'stephen'): admin
Email address: 
Password: 
Password (again): 
This password is too common.
Bypass password validation and create user anyway? [y/N]: y
Superuser created successfully.

郵件地址能夠不填，註冊成功後便可登陸。使用admin後臺來管理模型須要先註冊，修改blog_api/admin.py代碼

#導入模型User,Article
from blog_api.models import User,Article

admin.site.register(User)
admin.site.register(Article)

刷新admin後臺，就能夠看到剛剛註冊的模型了。

四、修改urls.py

from  blog_api.views import add_article,modify_article
urlpatterns = [
    path('admin/', admin.site.urls),
    path('articles/',add_article),
    path('articles/<int:art_id>',modify_article)
]

五、新增文章接口

from django.http import HttpResponse,JsonResponse
from blog_api.models import User,Article
import json

#新增文章
def add_article(request):
    if request.method == "POST":
        req = json.loads(request.body)
        print (req)
        key_flag = req.get("title") and req.get("content") and len(req)==2
        #判斷請求體是否正確
        if key_flag:
            title = req["title"]
            content = req["content"]
            #title返回的是一個list
            title_exist = Article.objects.filter(title=title)
            #判斷是否存在同名title
            if len(title_exist) != 0:
                return JsonResponse({"status":"BS.400","msg":"title aleady exist,fail to publish."})

            '''插入數據'''
            add_art = Article(title=title,content=content,status="alive")
            add_art.save()
            return JsonResponse({"status":"BS.200","msg":"publish article sucess."})
        else:
            return  JsonResponse({"status":"BS.400","message":"please check param."})

使用postman工具調用接口，運行結果：

六、查詢文章接口

#查詢全部文章和狀態
    if request.method == "GET":
        articles = {}
        query_art = Article.objects.all()
        for title in query_art:
            articles[title.title] = title.status
        return JsonResponse({"status":"BS.200","all_titles":articles,"msg":"query articles sucess."})

運行結果：

七、修改文章接口

#修改文章
def modify_article(request,art_id):
    if request.method == "POST":
        req = json.loads(request.body)
        try:
            art = Article.objects.get(id=art_id)
            key_flag = req.get("title") and req.get("content") and len(req)==2
            if key_flag:
                title = req["title"]
                content = req["content"]
                title_exist = Article.objects.filter(title=title)
                if len(title_exist) > 1:
                    return JsonResponse({"status":"BS.400","msg":"title aleady exist."})
                '''更新數據'''
                old_art = Article.objects.get(id=art_id)
                old_art.title = title
                old_art.content = content
                old_art.save()
                return JsonResponse({"status":"BS.200","msg":"modify article sucess."})
        except Article.DoesNotExist:
            return  JsonResponse({"status":"BS.300","msg":"article is not exists,fail to modify."})

運行結果：

八、刪除文章接口

#刪除文章
    if request.method == "DELETE":
        try:
            art = Article.objects.get(id=art_id)
            art_id = art.id
            art.delete()
            return JsonResponse({"status":"BS.200","msg":"delete article sucess."})
        except Article.DoesNotExist:
            return JsonResponse({"status":"BS.300","msg":"article is not exists,fail to delete."})

運行結果：

九、鑑權

四個簡單的接口已經能夠運行了，可是在發請求以前沒有進行鑑權，毫無安全性可言。下面來實現簡單的認證機制。須要用到內建模塊hashlib，hashlib提供了常見的摘要算法，如MD5，SHA1等。

鑑權接口

新增一個專門用於鑑權的接口。在urls.py中添加

path("auth/",get_token)

在views.py前面新增函數get_token(request)

import hashlib

#獲取token
def get_token(request):
    req = json.loads(request.body)
    uname = req["username"]
    upwd = req["password"]
    if request.method == "POST":
        try:
            tmppwd =User.objects.get(uname=uname).upwd
            if upwd == tmppwd:
                md5 = hashlib.md5()
                #把密碼變成一個長度固定的字符串
                md5.update(upwd.encode("utf-8"))
                return JsonResponse({"status":"BS.201","X-Token":md5.hexdigest()})
            else:
                return JsonResponse({"status":"BS.401","msg":"username or password may wrong."})

        except User.DoesNotExist:
            return JsonResponse({"status":"BS.500","msg":"username is not exist."})

登陸django admin在blog_api下的User表新增一條記錄。運行結果：

用戶認證

request.META.get(「header key」) 用於獲取header的信息。注意的是header key必須增長前綴HTTP，同時大寫，中劃先會轉成下劃線，例如你的key爲X-Token，那麼應該寫成request.META.get("HTTP_X_TOKEN")，修改views.py在get_token後面加上以下代碼：

#認證動做
def user_auth(request):

    token = request.META.get("HTTP_X_TOKEN",b'')
    print (token)
    if token:
        #暫時先寫上auth接口返回的數據
        if token=="0a6db4e59c7fff2b2b94a297e2e5632e":
            return "auth_sucess"
        else:
            return "auth_fail"
    else:
        return  "auth_fail"

在接口中調用user_auth函數，以發佈文章接口爲例：

#新增文章
def add_article(request):
    auth_res = user_auth(request)
    if auth_res == "auth_fail":
        return JsonResponse({"status":"BS.401","msg":"user auth failed."})
    else:
        if request.method == "POST":
            req = json.loads(request.body)
            print (req)
            .......

再次使用postman工具調用新增文章接口，Header中沒有X-Token或X-Token錯誤時的運行結果：