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

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

需求

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

环境

Python3.6 ,PyCharm,W7

项目结构

功能实现

流程

 

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

安装

1 2 3

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

配置

1 2 3 4

INSTALLED_APPS = (  ...  'rest_framework', )

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

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 编写如下代码

1 2 3 4 5 6

from django.conf.urls import url from Api import views urlpatterns = [  url(r'^runJob/$',views.run_job), ]

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

1 2 3 4 5 6 7 8 9

ALLOWED_HOSTS = '*' # 修改为* 代码允许任意host from django.conf.urls import url,include urlpatterns = [  url(r'^admin/', admin.site.urls),  url(r'^',include('Api.urls')),# 新增 ]

④:启动服务

1	python manage.py runserver 0.0.0.0:8080

 

⑤:我们请求试试看

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

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

后续

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

实现异步接口

实现定时任务

​现在我也找了很多测试的朋友，做了一个分享技术的交流群，共享了很多我们收集的技术文档和视频教程。
如果你不想再体验自学时找不到资源，没人解答问题，坚持几天便放弃的感受
可以加入我们一起交流。而且还有很多在自动化，性能，安全，测试开发等等方面有一定建树的技术大牛
分享他们的经验，还会分享很多直播讲座和技术沙龙
可以免费学习！划重点！开源的！！！
qq群号：485187702【暗号：csdn11】

最后感谢每一个认真阅读我文章的人，看着粉丝一路的上涨和关注，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走！ 希望能帮助到你！【100%无套路免费领取】