Django 自动生成api接口文档教程

2023-08-08 14:29:04 441

最近在写测试平台，需要实现一个节点服务器的api,正好在用django，准备使用djangorestframework插件实现。

需求

实现一个接口，在调用时，通过传递的参数，直接运行对应项目的自动化测试

环境

Python3.6,PyCharm,W7

项目结构

功能实现

流程

我们要做的就是实现以上流程

安装

pipinstalldjangorestframework
pipinstallmarkdown
pipinstalldjango-filter#Filteringsupport

配置

INSTALLED_APPS=(
...
'rest_framework',
)

编写代码(本次代码不涉及数据库操作，只简单的写一个api)

①:打开AutoApi/Api/views.py编写如下代码

fromdjango.httpimportJsonResponse,HttpResponseNotAllowed,HttpResponse
fromdjango.views.decorators.csrfimportcsrf_exempt
fromrest_framework.parsersimportJSONParser
fromrest_frameworkimportstatus

@csrf_exempt
defrun_job(request):
#判断请求头是否为json
ifrequest.content_type!='application/json':
#如果不是的话，返回405
returnHttpResponse('onlysupportjsondata',status=status.HTTP_415_UNSUPPORTED_MEDIA_TYPE)
#判断是否为post请求
ifrequest.method=='POST':
try:
#解析请求的json格式入参
data=JSONParser().parse(request)
exceptExceptionaswhy:
print(why.args)
else:
content={'msg':'SUCCESS'}
print(data)
#返回自定义请求内容content,200状态码
returnJsonResponse(data=content,status=status.HTTP_200_OK)
#如果不是post请求返回不支持的请求方法
returnHttpResponseNotAllowed(permitted_methods=['POST'])

②:打开AutoApi/Api/urls.py编写如下代码

fromdjango.conf.urlsimporturl
fromApiimportviews

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

③:打开AutoApi/AutoApi/urls.py修改如下代码

ALLOWED_HOSTS='*'#修改为*代码允许任意host


fromdjango.conf.urlsimporturl,include

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

④:启动服务

pythonmanage.pyrunserver0.0.0.0:8080

⑤:我们请求试试看

以上就是简单的实现一个api，其实开发说的接口就这么简单，没有那么神秘！

接下来把post的数据env，project，cases解析出来传给对应的自动化测试入口函数，就可以实现通过接口请求，启动自动化测试的目的。

后续

实现接口调用自动化测试项目

实现异步接口

实现定时任务

这篇Django自动生成api接口文档教程就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持毛票票。

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

Django 自动生成api接口文档教程

热门推荐

随机推荐