浅谈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 相关文章推荐
python Django模板的使用方法
Jan 14 Python
Python 如何访问外围作用域中的变量
Sep 11 Python
Python插件virtualenv搭建虚拟环境
Nov 20 Python
Python机器学习算法之k均值聚类(k-means)
Feb 23 Python
python列表生成式与列表生成器的使用
Feb 23 Python
对python数据切割归并算法的实例讲解
Dec 12 Python
python可视化实现代码
Jan 15 Python
python 寻找离散序列极值点的方法
Jul 10 Python
Python替换月份为英文缩写的实现方法
Jul 15 Python
python读取excel数据绘制简单曲线图的完整步骤记录
Oct 30 Python
Python爬虫UA伪装爬取的实例讲解
Feb 19 Python
Pytorch如何切换 cpu和gpu的使用详解
Mar 01 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
后宫无数却洁身自好的男主,唐三只爱小舞
2020/03/02 国漫
PHP用SAX解析XML的实现代码与问题分析
2011/08/22 PHP
深入PHP nl2br()格式化输出的详解
2013/06/05 PHP
解析php中die(),exit(),return的区别
2013/06/20 PHP
ThinkPHP CURD方法之where方法详解
2014/06/18 PHP
php使用正则表达式进行字符串搜索的方法
2015/03/23 PHP
php实现二进制和文本相互转换的方法
2015/04/18 PHP
完整显示当前日期和时间的JS代码
2007/09/17 Javascript
js导出格式化的excel 实例方法
2013/07/17 Javascript
Jquery插件编写简明教程
2014/03/25 Javascript
React.js入门学习第一篇
2016/03/30 Javascript
js+flash实现的5图变换效果广告代码(附演示与demo源码下载)
2016/04/01 Javascript
浅谈Nodejs应用主文件index.js
2016/08/28 NodeJs
关于jQuery.ajax()的jsonp碰上post详解
2017/07/02 jQuery
用JavaScript做简易的购物车的代码示例
2017/10/20 Javascript
jQuery使用each遍历循环的方法
2018/09/19 jQuery
详解Vue 全局变量,局部变量
2019/04/17 Javascript
jQuery实现图片随机切换、抽奖功能(实例代码)
2019/10/23 jQuery
使用python提取html文件中的特定数据的实现代码
2013/03/24 Python
python学习之面向对象【入门初级篇】
2017/01/21 Python
浅谈Python中range和xrange的区别
2017/12/20 Python
解决Pycharm调用Turtle时 窗口一闪而过的问题
2019/02/16 Python
python实现ip地址查询经纬度定位详解
2019/08/30 Python
导入tensorflow:ImportError: libcublas.so.9.0 报错
2020/01/06 Python
Python多线程Threading、子线程与守护线程实例详解
2020/03/24 Python
一款基于css3和jquery实现的动画显示弹出层按钮教程
2015/01/04 HTML / CSS
html5中为audio标签增加停止按钮动作实现方法
2013/01/04 HTML / CSS
德国消费电子产品购物网站:Guter Kauf
2020/09/15 全球购物
金融系毕业生自荐书
2014/07/08 职场文书
夫妻分居协议书范本
2014/11/28 职场文书
公司承诺函范文
2015/01/21 职场文书
工作违纪检讨书范文
2015/01/26 职场文书
幼儿园心得体会范文
2016/01/21 职场文书
Python图像处理之图像拼接
2021/04/28 Python
光之国的四大叛徒:第一贝利亚导致宇宙毁灭,赛文奥特曼在榜
2022/03/18 日漫
Redis配置外网可访问(redis远程连接不上)的方法
2022/12/24 Redis