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

 更新时间:2019年11月19日 15:48:36   作者:Op小剑  
今天小编就为大家分享一篇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

⑤:我们请求试试看

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

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

后续

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

实现异步接口

实现定时任务

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

相关文章

  • 详解Python开发语言中的基本数据类型

    详解Python开发语言中的基本数据类型

    数据类型想必大家都知道是什么含义,指的是输入数据的类型,任何数据都有明确的数据类型。本文主要和大家聊聊Python的三种基本数据类型,感兴趣的可以了解一下
    2022-10-10
  • Python如何发送Syslog日志

    Python如何发送Syslog日志

    这篇文章主要介绍了Python如何发送Syslog日志问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-09-09
  • Python进阶之递归函数的用法及其示例

    Python进阶之递归函数的用法及其示例

    本篇文章主要介绍了Python进阶之递归函数的用法及其示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • python time模块时间戳 与 结构化时间详解

    python time模块时间戳 与 结构化时间详解

    这篇文章主要介绍了python time模块 时间戳 与 结构化时间的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • 浅谈python中的错误与异常

    浅谈python中的错误与异常

    写Python代码的小伙伴不可避免地会遇到代码执行错误和异常,这次就来详细的总结一下python中的错误和异常
    2021-06-06
  • 解决python删除文件的权限错误问题

    解决python删除文件的权限错误问题

    下面小编就为大家分享一篇解决python删除文件的权限错误问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-04-04
  • 通过Python实现控制手机详解

    通过Python实现控制手机详解

    如今python是非常多人学习的,而手机也几乎人手一部。对于很多Python学习者,想用python来完成android手机中各种炫酷的的控制,adb是必不可缺少的工具之一
    2021-10-10
  • python使用os.listdir和os.walk获得文件的路径的方法

    python使用os.listdir和os.walk获得文件的路径的方法

    本篇文章主要介绍了python使用os.listdir和os.walk获得文件的路径的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-12-12
  • python 简单的多线程链接实现代码

    python 简单的多线程链接实现代码

    这篇文章主要介绍了python 简单的多线程链接实现代码,需要的朋友可以参考下
    2016-08-08
  • Python文件操作类操作实例详解

    Python文件操作类操作实例详解

    这篇文章主要介绍了Python文件操作类操作实例代码,需要的朋友可以参考下
    2014-07-07

最新评论