Django如何自動生成api接口文檔

這篇文章給大家分享的是有關Django如何自動生成api接口文檔的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

最近在寫測試平臺，需要實現一個節點服務器的api,正好在用django，準備使用djangorestframework插件實現。

需求

實現一個接口，在調用時，通過傳遞的參數，直接運行對應項目的自動化測試

環境

Python3.6 ,PyCharm,W7

項目結構

功能實現

流程

我們要做的就是實現以上流程

安裝

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

配置

INSTALLED_APPS = (
 ...
 'rest_framework',
)

編寫代碼(本次代碼不涉及數據庫操作，只簡單的寫一個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格式入參
   data = JSONParser().parse(request)
  except Exception as why:
   print(why.args)
  else:
   content = {'msg': 'SUCCESS'}
   print(data)
   # 返回自定義請求內容content,200狀態碼
   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')),# 新增
]

④:啟動服務

python manage.py runserver 0.0.0.0:8080

⑤:我們請求試試看

感謝各位的閱讀！關于“Django如何自動生成api接口文檔”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！