最近在寫測試平臺，需要實現一個節點服務器的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

⑤:我們請求試試看

以上就是簡單的實現一個api ，其實開發說的接口就這么簡單，沒有那么神秘！

接下來把post 的數據env ，project，cases 解析出來傳給對應的自動化測試入口函數，就可以實現通過接口請求，啟動自動化測試的目的。

后續

實現接口調用自動化測試項目

實現異步接口

實現定時任務

這篇Django 自動生成api接口文檔教程就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支持我們。

總結

以上是生活随笔為你收集整理的python生成api文档_Django 自动生成api接口文档教程的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。