浅谈django框架集成swagger以及自定义参数问题


Posted in Python onJuly 07, 2020

介绍

我们在实际的开发工作中需要将django框架与swagger进行集成,用于生成API文档。网上也有一些关于django集成swagger的例子,但由于每个项目使用的依赖版本不一样,因此可能有些例子并不适合我们。我也是在实际集成过程中遇到了一些问题,例如如何自定义参数等问题,最终成功集成,并将结果分享给大家。

开发版本

我开发使用的依赖版本,我所使用的都是截止发稿日期为止最新的版本:

Django 2.2.7

django-rest-swagger 2.2.0

djangorestframework 3.10.3

修改settings.py

1、项目引入rest_framework_swagger依赖

INSTALLED_APPS = [
 ......
 'rest_framework_swagger',
 ......
]

2、设置DEFAULT_SCHEMA_CLASS,此处不设置后续会报错。

REST_FRAMEWORK = {
 ......
 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.AutoSchema',
 ......
}

在app下面创建schema_view.py

在此文件中,我们要继承coreapi中的SchemaGenerator类,并重写get_links方法,重写的目的就是实现我们自定义参数,并且能在页面上展示。此处直接复制过去使用即可。

from rest_framework.schemas import SchemaGenerator
from rest_framework.schemas.coreapi import LinkNode, insert_into
from rest_framework.renderers import *
from rest_framework_swagger import renderers
from rest_framework.response import Response
from rest_framework.decorators import APIView
from rest_framework.permissions import AllowAny,IsAuthenticated,IsAuthenticatedOrReadOnly
from django.http import JsonResponse

class MySchemaGenerator(SchemaGenerator):

 def get_links(self, request=None):
  links = LinkNode()

  paths = []
  view_endpoints = []
  for path, method, callback in self.endpoints:
   view = self.create_view(callback, method, request)
   path = self.coerce_path(path, method, view)
   paths.append(path)
   view_endpoints.append((path, method, view))

  # Only generate the path prefix for paths that will be included
  if not paths:
   return None
  prefix = self.determine_path_prefix(paths)

  for path, method, view in view_endpoints:
   if not self.has_view_permissions(path, method, view):
    continue
   link = view.schema.get_link(path, method, base_url=self.url)
   # 添加下面这一行方便在views编写过程中自定义参数.
   link._fields += self.get_core_fields(view)

   subpath = path[len(prefix):]
   keys = self.get_keys(subpath, method, view)

   # from rest_framework.schemas.generators import LinkNode, insert_into
   insert_into(links, keys, link)

  return links

 # 从类中取出我们自定义的参数, 交给swagger 以生成接口文档.
 def get_core_fields(self, view):
  return getattr(view, 'coreapi_fields', ())

class SwaggerSchemaView(APIView):
 _ignore_model_permissions = True
 exclude_from_schema = True

 #permission_classes = [AllowAny]
 # 此处涉及最终展示页面权限问题,如果不需要认证,则使用AllowAny,这里需要权限认证,因此使用IsAuthenticated
 permission_classes = [IsAuthenticated]
 # from rest_framework.renderers import *
 renderer_classes = [
  CoreJSONRenderer,
  renderers.OpenAPIRenderer,
  renderers.SwaggerUIRenderer
 ]

 def get(self, request):
  # 此处的titile和description属性是最终页面最上端展示的标题和描述
  generator = MySchemaGenerator(title='API说明文档',description='''接口测试、说明文档''')

  schema = generator.get_schema(request=request)

  # from rest_framework.response import Response
  return Response(schema)


def DocParam(name="default", location="query",required=True, description=None, type="string",
    *args, **kwargs):
 return coreapi.Field(name=name, location=location,
       required=required, description=description,
       type=type)

实际应用

在你的应用中定义一个接口,并发布。我这里使用一个测试接口进行验证。

注意

1、所有的接口必须采用calss的方式定义,因为要继承APIView。

2、class下方的注释post,是用来描述post方法的作用,会在页面上进行展示。

3、coreapi_fields 中定义的属性name是参数名称,location是传值方式,我这里一个采用query查询,一个采用header,因为我们进行身份认证,必须将token放在header中,如果你没有,去掉就好了,这里的参数根据你实际项目需要进行定义。

4、最后定义post方法,也可以是get、put等等,根据实际情况定义。

# 这里是之前在schema_view.py中定义好的通用方法,引入进来 
from app.schema_view import DocParam

'''
 测试
'''
class CustomView(APIView):
 '''
 post:
  测试测试测试
 '''
 coreapi_fields = (
  DocParam(name="id",location='query',description='测试接口'),
  DocParam(name="AUTHORIZATION", location='header', description='token'),
 )

 def post(self, request):
  print(request.query_params.get('id'));
  return JsonResponse({'message':'成功!'})

5、接收参数这块一定要注意,我定义了一个公用的方法,这里不做过多阐述,如实际过程遇到应用接口与swagger调用接口的传值问题,可参考如下代码。

def getparam(attr,request):
 obj = request.POST.get(attr);
 if obj is None:
  obj = request.query_params.get(attr);
 return obj;

修改url.py

针对上一步中定义的测试接口,我们做如下配置。

from django.contrib import admin
from rest_framework import routers
from django.conf.urls import url,include

# 下面是刚才自定义的schema
from app.schema_view import SwaggerSchemaView
# 自定义接口
from app.recommend import CustomView

router = routers.DefaultRouter()

urlpatterns = [
 # swagger接口文档路由
 url(r"^docs/$", SwaggerSchemaView.as_view()),
 url(r'^admin/', admin.site.urls),
 url(r'^', include(router.urls)),
 # drf登录
 url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))

 # 测试接口
 url(r'^test1', CustomView.as_view(), name='test1'),
]

效果展示

访问地址:http://localhost:8001/docs/

浅谈django框架集成swagger以及自定义参数问题

浅谈django框架集成swagger以及自定义参数问题

总结

以上这篇浅谈django框架集成swagger以及自定义参数问题就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Python 相关文章推荐
压缩包密码破解示例分享(类似典破解)
Jan 17 Python
Python实现的简单万年历例子分享
Apr 25 Python
Python re模块介绍
Nov 30 Python
python处理xml文件的方法小结
May 02 Python
Python中使用多进程来实现并行处理的方法小结
Aug 09 Python
Python闭包思想与用法浅析
Dec 27 Python
详解Python 解压缩文件
Apr 09 Python
Django REST framework 单元测试实例解析
Nov 07 Python
Python彻底删除文件夹及其子文件方式
Dec 23 Python
Python面向对象中类(class)的简单理解与用法分析
Feb 21 Python
python 三种方法实现对Excel表格的读写
Nov 19 Python
python 监控服务器是否有人远程登录(详细思路+代码)
Dec 18 Python
Django REST Swagger实现指定api参数
Jul 07 #Python
python中查看.db文件中表格的名字及表格中的字段操作
Jul 07 #Python
python db类用法说明
Jul 07 #Python
python文件编写好后如何实践
Jul 07 #Python
python 删除excel表格重复行,数据预处理操作
Jul 06 #Python
pandas.DataFrame.drop_duplicates 用法介绍
Jul 06 #Python
TensorFlow Autodiff自动微分详解
Jul 06 #Python
You might like
第4章 数据处理-php数组的处理-郑阿奇
2011/07/04 PHP
ThinkPHP的cookie和session冲突造成Cookie不能使用的解决方法
2014/07/01 PHP
Yii2 ActiveRecord多表关联及多表关联搜索的实现
2016/06/30 PHP
jQuery 技巧大全(新手入门篇)
2009/05/12 Javascript
jQuery技巧总结
2011/01/01 Javascript
Prototype源码浅析 String部分(二)
2012/01/16 Javascript
js随机颜色代码的多种实现方式
2013/04/23 Javascript
在firefox和Chrome下关闭浏览器窗口无效的解决方法
2014/01/16 Javascript
jquery实现背景墙聚光灯效果示例分享
2014/03/02 Javascript
javascript简单实现滑动菜单效果的方法
2015/07/27 Javascript
AngularJS自动表单验证
2016/02/01 Javascript
详谈javascript精度问题与调整
2017/07/08 Javascript
webpack多入口文件页面打包配置详解
2018/01/09 Javascript
mint-ui在vue中的使用示例
2018/04/05 Javascript
vue 动态绑定背景图片的方法
2018/08/10 Javascript
三分钟教你用Node做一个微信哄女友(基友)神器(面向小白)
2019/06/21 Javascript
[01:02:03]2014 DOTA2华西杯精英邀请赛 5 24 NewBee VS VG
2014/05/26 DOTA
python抓取百度首页的方法
2015/05/19 Python
详解Python中的变量及其命名和打印
2016/03/11 Python
基于python OpenCV实现动态人脸检测
2018/05/25 Python
使用python进行文本预处理和提取特征的实例
2018/06/05 Python
python如何求解两数的最大公约数
2018/09/27 Python
Python多线程threading模块用法实例分析
2019/05/22 Python
Java Spring项目国际化(i18n)详细方法与实例
2020/03/20 Python
Python实现一个简单的毕业生信息管理系统的示例代码
2020/06/08 Python
python等待10秒执行下一命令的方法
2020/07/19 Python
想学画画?python满足你!
2020/12/24 Python
Matplotlib配色之Colormap详解
2021/01/05 Python
be2台湾单身男女交友:全球网路婚姻介绍的领导品牌
2019/10/11 全球购物
某公司面试题
2012/03/05 面试题
初中作文评语大全
2014/04/23 职场文书
数学兴趣小组活动总结
2014/07/08 职场文书
“九一八事变纪念日”国旗下讲话稿
2014/09/14 职场文书
个人融资协议书范本两则
2014/10/15 职场文书
python批量更改目录名/文件名的方法
2021/04/18 Python
MySQL Server层四个日志的实现
2022/03/31 MySQL