python api接口生成_Django 自动生成api接口文档教程
最近在寫測(cè)試平臺(tái),需要實(shí)現(xiàn)一個(gè)節(jié)點(diǎn)服務(wù)器的api,正好在用django,準(zhǔn)備使用djangorestframework插件實(shí)現(xiàn)。
需求
實(shí)現(xiàn)一個(gè)接口,在調(diào)用時(shí),通過傳遞的參數(shù),直接運(yùn)行對(duì)應(yīng)項(xiàng)目的自動(dòng)化測(cè)試
環(huán)境
Python3.6 ,PyCharm,W7
項(xiàng)目結(jié)構(gòu)
功能實(shí)現(xiàn)
流程
我們要做的就是實(shí)現(xiàn)以上流程
安裝
pip install djangorestframework
pip install markdown
pip install django-filter # Filtering support
配置
INSTALLED_APPS = (
...
'rest_framework',
)
編寫代碼(本次代碼不涉及數(shù)據(jù)庫(kù)操作,只簡(jiǎn)單的寫一個(gè)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):
# 判斷請(qǐng)求頭是否為json
if request.content_type != 'application/json':
# 如果不是的話,返回405
return HttpResponse('only support json data', status=status.HTTP_415_UNSUPPORTED_MEDIA_TYPE)
# 判斷是否為post 請(qǐng)求
if request.method == 'POST':
try:
# 解析請(qǐng)求的json格式入?yún)?/p>
data = JSONParser().parse(request)
except Exception as why:
print(why.args)
else:
content = {'msg': 'SUCCESS'}
print(data)
# 返回自定義請(qǐng)求內(nèi)容content,200狀態(tài)碼
return JsonResponse(data=content, status=status.HTTP_200_OK)
# 如果不是post 請(qǐng)求返回不支持的請(qǐng)求方法
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')),# 新增
]
④:啟動(dòng)服務(wù)
python manage.py runserver 0.0.0.0:8080
⑤:我們請(qǐng)求試試看
以上就是簡(jiǎn)單的實(shí)現(xiàn)一個(gè)api ,其實(shí)開發(fā)說的接口就這么簡(jiǎn)單,沒有那么神秘!
接下來把post 的數(shù)據(jù)env ,project,cases 解析出來傳給對(duì)應(yīng)的自動(dòng)化測(cè)試入口函數(shù),就可以實(shí)現(xiàn)通過接口請(qǐng)求,啟動(dòng)自動(dòng)化測(cè)試的目的。
后續(xù)
實(shí)現(xiàn)接口調(diào)用自動(dòng)化測(cè)試項(xiàng)目
實(shí)現(xiàn)異步接口
實(shí)現(xiàn)定時(shí)任務(wù)
這篇Django 自動(dòng)生成api接口文檔教程就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持python博客。
總結(jié)
以上是生活随笔為你收集整理的python api接口生成_Django 自动生成api接口文档教程的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: qq隐身对其可见在哪里 详细步骤介绍
- 下一篇: python的内存管理机制及调优手段_P