首页 > 其他分享 >Swagger UI接入配置

Swagger UI接入配置

时间:2023-01-19 12:01:07浏览次数:50  
标签:schema name 接入 UI DRF ui Swagger view

 

Swagger UI接入配置

这里的接入我们依赖于DRF官方推荐的一个第三方包: drf-yasg,下面的接入步骤其实都是按照这个第三方库的文档进行配置,这里只是个最最入门的使用,对于更加高阶或者定制化的需求,可以先参考官方文档,后续也会推出基于这个库进行定制化的文章。

其实,drf-yasg的接入是非常简单的,只需要在Django项目下实例化对应的scheme_view,然后添加对应的路由即可:

# django_project_name/urls.py
from drf_yasg import openapi
from drf_yasg.views import get_schema_view

schema_view = get_schema_view(
    openapi.Info(
        title="DRF TOOLS API",
        default_version="v1",
    ),
    public=True,
)

urlpatterns += [
    url(r"^swagger(?P<format>\.json|\.yaml)$", schema_view.without_ui(cache_timeout=0), name="schema-json"),
    url(r"^swagger/$", schema_view.with_ui("swagger", cache_timeout=0), name="schema-swagger-ui"),
    url(r"^redoc/$", schema_view.with_ui("redoc", cache_timeout=0), name="schema-redoc"),
]

 

错误处理:

AttributeError: module 'rest_framework.serializers' has no attribute 'NullBooleanField'

通过查询相关资料得知,在djangorestframework版本为3.14.0中,已经将'NullBooleanField'

这个属性删除了,详情可见下方解释
github.com
https://github.com/encode/django-rest-framework/pull/8599

 

所以若使用3.14.0的DRF涉及以上问题,那就一定会报这个错误!

那既然问题已经找到了那就很好解决啦

我们只要将DRF的版本降低一些就可以啦 本人使用版本为3.13.1

完美解决!!!

 

标签:schema,name,接入,UI,DRF,ui,Swagger,view
From: https://www.cnblogs.com/beichengshiqiao/p/17061272.html

相关文章

  • qt ui_xxx.h no file or directory
    今天是2023年1.19,22号就过年了,先祝大家新年快乐!首先经过这几天的研究,出现这个问题,提示其实已经很明显了,就是没找到文件,那么为什么没找到文件呢?基本上就是编译的时候没有找......
  • Gradle build.gradle 文件
    build.gradle是一个gradle的构建脚本文件,支持java、groovy等语言。每个project都会有一个build.gradle文件,该文件是项目构建的入口,可配置版本、插件、依赖库等......
  • Arduino控制舵机
    感谢大神 Arduino控制舵机详解(含代码)_项目申报小狂人的博客-CSDN博客1.舵机简介舵机是一种位置(角度)伺服的驱动器。舵机只是一种通俗的叫法,其实质是一个伺服马达......
  • 使用 Burpsuite 测试的常用操作(一)
    大家好啊,我是大田。今天分享一下Burpsuite在工作中常用操作,本文先说说其中两个操作。一、了解一下Burpsuite做什么1、Burpsuite是一个黑客工具、安全测试工具、半......
  • 疯狂吐槽 MAUI 以及 MAUI 入坑知识点
    目录窗口窗口管理如何限制一次只能打开一个程序MAUI程序安装模式为MAUIBlazor设置语言坑①坑②坑③配置MAUI项目使用管理员权限启动问题背景定制编译过程MAUI实......
  • Swagger快速使用
    Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。pom<!--https://mvnrepository.com/artifact/io.springfox/springfox-swagger2-......
  • Springboot整合swagger3
    引入依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-boot-starter</artifactId><version>3.0.0</ve......
  • 在SOUI中将自定义配置信息写到布局文件中
    SOUI的布局XML文件保存布局必须的信息。特定场合中,用户可能会需要在布局中指定业务需要处理的属性。比如启程输入法的皮肤。有的皮肤支持高分屏,有的皮肤不支持。对于这个......
  • EasyUi中的treegrid删除一条记录后,被删除的数据仍处于被选中状态
    使用treegrid展示数据时,删除一条数据之后选中另外一条进行编辑,提示“只能操作一条数据”,使用console打印出来发现,删除的数据仍处于被选中的状态。 解决方法:删除数据之......
  • 在SOUI中使用GetAttribute获取XML中配置的属性
    SOUI的界面布局使用XML来布局,在XML配置的属性值会通过SObject::SetAttribute(name,value)的方式交给SObject处理。SWindow是SOUI的界面元素对象,继承自SObject,同样也是通......