DRF使用swagger进行自动生成API接口-2

最新推荐文章于 2023-08-07 19:45:04 发布
最新推荐文章于 2023-08-07 19:45:04 发布
阅读量960 收藏
点赞数
分类专栏： oauth2.0 swagger Django 文章标签： swagger api drf
@passion_wo
本文链接：https://blog.csdn.net/qq_38198897/article/details/103454279
版权

自定义swagger认证方式

  • 设置SWAGGER_SETTINGS 在 settings.py文件中

  • oauth2.0的配置

    • USE_SESSION_AUTH : True则显示图一中红框中的login按钮, False不显示
    • SECURITY_DEFINITIONS: swagger的安全定义图一
    SWAGGER_SETTINGS = {
     
    'USE_SESSION_AUTH': False,
    'SECURITY_DEFINITIONS': {
     
        'DEMO系统': {
最低0.47元/天 解锁文章
passion_wo
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
DRF使用swagger进行自动生成API接口-1
passion
12-04 1990
Django Rest Framework自动生成API接口–swagger 推荐 drf_yasg 第三方包 推荐原因 紧密结合了DRF框架, 灵活 使用swagger生成API (swagger的优点不再赘述) 同时使用 redoc 生成详细的接口文档 不想看本文的直接跳转官网 安装pip install -U drf-yasg 配置+使用# settings.py I...
drf-yasg：从Django REST框架代码自动生成真正的SwaggerOpenAPI 2.0模式
02-05
drf-yasg：从Django REST框架代码自动生成真正的SwaggerOpenAPI 2.0模式
DRF 自动生成接口文档
zhushixia1989的博客
07-13 466
关于使用drf-yasg中的swagger实现能够上传文件的测试功能
qq_38977315的博客
09-18 605
django更改存储方式，实现连接sftp上传文件到其他服务器 下面只是简单地实现方法(demo)，具体内容视自己需求具体使用 关于使用drf-yasg中的swagger实现能够上传文件的测试功能 需要在视图文件中使用解析器，为了更改上传文件的头部信息，重点在’parser_classes’ 详情，可以参考drf-yasg的git中issues，有相关内容， 安装django-storages: ​ (django-storages封装了对python连接sftp的连接) pip install djang
浅谈django框架集成swagger以及自定义参数问题
09-16
主要介绍了浅谈django框架集成swagger以及自定义参数问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
Django REST Swagger实现指定api参数
12-17
为什么要指定swagger的api参数 api的参数有多种类型： query 参数，如 /users?role=admin path 参数，如 /users/{id} header 参数，如 X-MyHeader: Value body 参数，描述POST，PUT，PATCH请求的body form 参数，描述 Content-Type of application/x-www-form-urlencoded 和 multipart/form-data 的请求报文body的参数 swagger指定api参数就可以在文档相应的api条目中显示出api的描述、正常输出、异常输出、参数的名称、描述、
drf-swagger-customization:这是一个django应用，您可以通过drf API修改和改进自动生成的swagger文档
05-04
drf-swagger-定制 这是一个django应用程序，您可以通过drf API修改和改进自动生成的swagger文档。文献资料完整文档位于 。快速开始安装drf-swagger-customization： pip install drf-swagger-customization将这些...
drf-yasg-json-api:从Django Rest Framework JSON API端点自动生成SwaggerOpenAPI 2.0规范
05-08
drf-yasg-json-api- drf-yasg符合JSON API 从Django Rest Framework端点自动生成Swagger / OpenAPI 2.0 JSON API规范。 该软件包使和一起使用。 目录 filter查询参数 分页 额外的 支持drf-yasg swagger_auto_...
DRF-New-API-Pracitce-Project
03-17
9. **API 文档**：DRF 可以集成如 Swagger 或 Django Rest Swagger 来生成 API 的交互式文档，方便开发者和消费者理解和使用。 10. **性能优化**：包括缓存策略、分页、过滤、排序等，都是提高 API 性能的关键。 ...
drf-spectacular：用于Django REST框架的Sane和灵活的OpenAPI 3模式生成
02-04
`drf-spectacular`通过自动化OpenAPI文档生成，为Django REST框架的开发者提供了一种高效的方式，来管理和展示API接口。通过这个工具，项目可以保持规范的API设计，提升开发体验，同时方便其他开发者理解和使用API。...
django框架配置swagger以及自定义参数使用
weixin_62935305的博客
06-16 6324
1.初步了解swagger 2.swagger优势 3.django中的配置 4.自定义参数的配置
django中的DRF框架的coreapi和swagger自动生成接口文档
最新发布
2301_76931745的博客
08-07 649
1）单⼀⽅法的视图，可直接使⽤类视图的⽂档字符串，如2）包含多个⽅法的视图，在类视图的⽂档字符串中，分开⽅法定义，如3）对于视图集ViewSet，仍在类视图的文档字符串中分开定义，但是应使用action名称区分，如。
swagger 全局token设置
qq_39508627的博客
10-16 2032
Swagger是一个很方便的东东，但正常使用时，我们的接口需要登陆才能访问的。即登陆时，要传一个登陆后的token才能访问的。 那这个怎么设置，才可以让所有接口都允许登陆后访问呢。 解决办法如下： @EnableSwagger2 @Configuration public class SwggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGE
Spring Boot —— Security & Swagger2 问题总结
Genius only means hard-working all one's life.
07-10 3117
文章目录Spring Boot —— Security & Swagger2 问题总结前言汇总问题1. CORS（跨域资源分享）产生的权限问题，并给出Spring Security处理Preflight的方法2. 集成swagger2报错：java.lang.NoSuchMethodError:com.google.common.XXX3. swagger2的页面报错：Unable to ...
Django Swagger接口文档生成
shykevin的博客
07-06 6562
一、概述 引言 当接口开发完成，紧接着需要编写接口文档。传统的接口文档使用Word编写，or一些接口文档管理平台进行编写，但此类接口文档维护更新比较麻烦，每次接口有变更，需要手动修改接口文档。为了改善这种情况，推荐使用Swagger来管理接口文档，实现接口文档的自动更新。 简介 Swagger：是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目...
DRF 配置Swagger
yixinluobo的博客
07-28 860
最近项目组重新启动了一个项目，前后端分离方式进行开发。没搞过啊！前面都是单挑，看到前端小姐姐列出的一堆需求规范，直接麻了#o==o#! 麻了也要干活，应小姐姐要求接口文档直接使用swagger，那么问题来了！这玩意也没用过，请教前端小姐姐直接白了我一眼“这个我也不会”。还是要面向百度编程。 找了一堆教程然后开始配置 首先安装： pip install django-rest-swagger 然后添加在settings文件添加app配置 在主urls.py 配置路径： from re..
Django+rest_framework+drf_yasg 生成swaggers在线API文档
热门推荐
u012328712的专栏
11-20 1万+
Django+rest_framework+drf_yasg 生成swaggers在线API文档 背景技术路线相关版本第一步：新建一个Django项目第二步：新建一个APP第三步：修改settings.py第四步：修改news/下修改views.py第五步：news/下新建urls.py并添加以下内容第六步：修改DjangoDrfTest/urls.py第七步：运行managy.py一些配置项参数...
Django之DRF-生成接口文档和swagger
weixin_47454485的博客
07-21 3251
一、功能简介 生成API文档平台 自动生成测试代码 支持接口测试 二、安装 coreapi（必须） Pygments（可选） MarkDown（可选 三、使用coreapi 1.最新版的DRF（>3.10）中，需要在全局配置文件settings.py中添加如下配置,可在DRF中查看版本 REST_FRAMEWORK = { # 指定支持coreapi的Schema 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.
DRF生成swagger文档
weixin_44149181的博客
04-13 1165
最近在做一个项目，重新搭建了drf项目，为了规范决定引入swagger文档 1.安装drf-yasg pip install drf-yasg 2.在setting里面引入 INSTALLED_APPS = [ 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages
django+drf+swagger写一个后端框架demo
05-10
好的，下面是一个使用 Django、Django REST framework 和 Swagger 的后端框架 demo。 首先，需要安装 Django、Django REST framework 和 Swagger： ``` pip install Django pip install djangorestframework pip install django-rest-swagger ``` 接着，创建一个 Django 项目： ``` django-admin startproject demo ``` 然后，在项目根目录下创建一个名为 `api` 的 Django app： ``` cd demo python manage.py startapp api ``` 接下来，修改 `demo/settings.py` 文件，将 `api` app 添加到 `INSTALLED_APPS` 列表中： ```python INSTALLED_APPS = [ # ... 'rest_framework', 'rest_framework_swagger', 'api', ] ``` 然后，在 `api` app 下创建一个名为 `views.py` 的文件，用于编写 API 视图函数： ```python from rest_framework.decorators import api_view from rest_framework.response import Response @api_view(['GET']) def hello(request): """ 返回一个简单的字符串 """ return Response("Hello, world!") ``` 接着，在 `api` app 下创建一个名为 `urls.py` 的文件，用于配置 API 路由： ```python from django.urls import path from rest_framework_swagger.views import get_swagger_view from . import views schema_view = get_swagger_view(title='API文档') urlpatterns = [ path('', schema_view), path('hello/', views.hello), ] ``` 最后，修改 `demo/settings.py` 文件，设置 REST framework 和 Swagger 的配置： ```python REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema' } SWAGGER_SETTINGS = { 'SECURITY_DEFINITIONS': { 'Basic': { 'type': 'basic' } }, } ``` 现在，运行 Django 项目： ``` python manage.py runserver ``` 在浏览器中访问 `http://127.0.0.1:8000/api/`，即可看到 Swagger 的 API 文档界面。在其中可以看到一个名为 `hello` 的 API，点击该 API 可以进行测试，测试结果将会返回一个字符串 "Hello, world!"。 这就是使用 Django、Django REST framework 和 Swagger 编写的一个后端框架 demo。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值