Django 自動生成api接口文檔教程

更新時間：2019年11月19日 15:48:36 作者：Op小劍

今天小編就為大家分享一篇Django 自動生成api接口文檔教程，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

最近在寫測試平臺，需要實現(xiàn)一個節(jié)點服務(wù)器的api,正好在用django，準(zhǔn)備使用djangorestframework插件實現(xiàn)。

需求

實現(xiàn)一個接口，在調(diào)用時，通過傳遞的參數(shù)，直接運行對應(yīng)項目的自動化測試

環(huán)境

Python3.6 ,PyCharm,W7

項目結(jié)構(gòu)

功能實現(xiàn)

流程

我們要做的就是實現(xiàn)以上流程

安裝

pip install djangorestframework 
pip install markdown 
pip install django-filter # Filtering support

配置

INSTALLED_APPS = (
 ...
 'rest_framework',
)

編寫代碼(本次代碼不涉及數(shù)據(jù)庫操作，只簡單的寫一個api)

①:打開AutoApi/Api/views.py 編寫如下代碼

from django.http import JsonResponse, HttpResponseNotAllowed, HttpResponse
from django.views.decorators.csrf import csrf_exempt
from rest_framework.parsers import JSONParser
from rest_framework import status

@csrf_exempt
def run_job(request):
 # 判斷請求頭是否為json
 if request.content_type != 'application/json': 
  # 如果不是的話，返回405
  return HttpResponse('only support json data', status=status.HTTP_415_UNSUPPORTED_MEDIA_TYPE)
 # 判斷是否為post 請求
 if request.method == 'POST':
  try:
   # 解析請求的json格式入?yún)?
   data = JSONParser().parse(request)
  except Exception as why:
   print(why.args)
  else:
   content = {'msg': 'SUCCESS'}
   print(data)
   # 返回自定義請求內(nèi)容content,200狀態(tài)碼
   return JsonResponse(data=content, status=status.HTTP_200_OK)
 # 如果不是post 請求返回不支持的請求方法
 return HttpResponseNotAllowed(permitted_methods=['POST'])

②:打開AutoApi/Api/urls.py 編寫如下代碼

from django.conf.urls import url
from Api import views

urlpatterns = [
 url(r'^runJob/$',views.run_job),
]

③:打開AutoApi/AutoApi/urls.py 修改如下代碼

ALLOWED_HOSTS = '*' # 修改為* 代碼允許任意host


from django.conf.urls import url,include

urlpatterns = [
 url(r'^admin/', admin.site.urls),
 url(r'^',include('Api.urls')),# 新增
]

④:啟動服務(wù)