首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

从Django REST Swagger中排除终结点HTTP方法

Django REST Swagger是一个用于自动生成API文档的工具,它可以根据Django REST Framework中定义的API视图和路由信息,生成可视化的API文档。在使用Django REST Swagger时,有时候我们希望排除某些终结点的HTTP方法,以便在生成的API文档中隐藏这些方法。

要从Django REST Swagger中排除终结点HTTP方法,可以通过在API视图中使用装饰器@swagger_auto_schema来实现。@swagger_auto_schema装饰器允许我们自定义API视图的Swagger文档。

下面是一个示例,展示如何使用@swagger_auto_schema装饰器来排除终结点HTTP方法:

代码语言:txt
复制
from rest_framework.decorators import api_view, renderer_classes
from rest_framework.response import Response
from rest_framework import status
from drf_yasg.utils import swagger_auto_schema

@swagger_auto_schema(
    methods=['GET', 'POST'],  # 仅包含GET和POST方法
    operation_id='example_endpoint',  # 操作ID
    operation_description='This is an example endpoint.',  # 操作描述
    responses={  # 响应示例
        status.HTTP_200_OK: 'Success',
        status.HTTP_400_BAD_REQUEST: 'Bad Request'
    }
)
@api_view(['GET', 'POST', 'PUT', 'DELETE'])
@renderer_classes([])
def example_endpoint(request):
    if request.method == 'GET':
        # 处理GET请求
        return Response('GET request processed.', status=status.HTTP_200_OK)
    elif request.method == 'POST':
        # 处理POST请求
        return Response('POST request processed.', status=status.HTTP_200_OK)
    elif request.method == 'PUT':
        # 处理PUT请求
        return Response('PUT request processed.', status=status.HTTP_200_OK)
    elif request.method == 'DELETE':
        # 处理DELETE请求
        return Response('DELETE request processed.', status=status.HTTP_200_OK)

在上面的示例中,@swagger_auto_schema装饰器用于自定义example_endpoint视图的Swagger文档。通过指定methods参数,我们可以仅包含GET和POST方法,从而排除PUT和DELETE方法。此外,我们还可以提供操作ID、操作描述和响应示例等信息。

这是一个简单的示例,你可以根据实际需求进行更复杂的配置。关于Django REST Swagger的更多用法和配置,请参考腾讯云的相关产品文档:Django REST Swagger

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

Django Swagger接口文档生成

2)Swagger可生成客户端SDK代码,用于不同平台上(Java、Python...)的实现 3)Swagger文件可在许多不同的平台上代码注释自动生成 4)Swagger有一个强大的社区,里面有许多强悍的贡献者...二、Django接入Swagger 大致步骤 1.安装django-rest-swagger 2.进入到setting.py文件,添加django-rest-swagger应用 3.进入到views.py...,将之前定义的UserViewSet和GroupViewset补充注释 4.在urls.py添加get_schema_view辅助函数 5.启动Django服务,检测Swagger接口文档配置效果 环境说明...    'APIS_SORTER': 'alpha',     # 如果支持json提交, 则接口文档包含json输入框     'JSON_EDITOR': True,     # 方法列表字母排序...三、访问页面 drf自带的接口UI http://127.0.0.1:8000/ 效果如下: ? Swagger UI http://127.0.0.1:8000/docs/ 效果如下: ?

4.1K40

Python3+ Django3:自动生成Swagger接口文档

例如:接口测试站点(http://httpbin.org/#/),也是利用Swagger来生成接口文档的。...3)Swagger可在不同的平台上代码注释自动生成 4)Swagger社区活跃,里面有许多强悍的贡献者 3....Django接入Swagger 网上很多资料在介绍Django接入Swagger方法时,都是基于django-rest-swagger库进行讲解的,都殊不知,2019年6月份开始,官方已经废弃了该库,...GitHub地址: https://github.com/marcgibbons/django-rest-swagger 所以本文也是基于drf-yasg库来实现在Django3接入Swagger框架的...PS: ReDoc 是另一个 Swagger UI 工具。 3、继续访问http://127.0.0.1:8000/swagger,即可看到日常我们熟悉的Swagger接口文档界面了。 ?

14.9K32

drf的接口文档生成与管理

生成接口文档 3.1 Swagger介绍 3.2 安装django-rest-swagger库 3.3 配置app及swagger 3.4 配置相关路由 3.5 访问查看 3.6 说明 4、drf-yasg...HostListView(generics.ListAPIView): """ 返回所有主机信息. """ 包含多个方法的视图,在类视图的文档字符串,分开方法定义 class......的实现 Swagger文件可在许多不同的平台上代码注释自动生成 Swagger有一个强大的社区,里面有许多强悍的贡献者 要提到的是,作为一个工具人,常用的httpbin模拟请求工具也是基于swagger...的 下面记录在drf通过swagger生成接口文档的具体实现流程,参考drf swagger文档 3.2 安装django-rest-swagger库 pip3 install django-rest-swagger...3.6 说明 Django REST Swagger19年开始就已弃用不再维护了,作者在官方网站上说明了更推荐使用drf-yasg 可以阅读https://github.com/marcgibbons

4.6K10

Django Rest Swagger生成api文档

关于swagger Swagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因: Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。...Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。 Swagger 文件可以在许多不同的平台上代码注释自动生成。 Swagger 有一个强大的社区,里面有许多强悍的贡献者。...下面就实战django rest swagger为drf生成api接口文档 环境 Python3.6 Django1.11 django-rest-swagger djangorestframework...安装 pip install django==1.11.6 pip instal djangorestframework pip install django-rest-swagger 创建项目和app...'APIS_SORTER': 'alpha', # 如果支持json提交, 则接口文档包含json输入框 'JSON_EDITOR': True, # 方法列表字母排序

3K10

FastAPI框架诞生的缘由(上)

但是有时候,没有更好的办法,除了创建具有所有这些功能的东西,以前的工具汲取最佳创意,并以最佳方式将它们组合起来,使用以前甚至没有的语言功能(Python 3.6+类型提示)。...Django REST Framework Django REST Framework 是一个非常灵活的框架,用于构建 Web API,以改善 Django 的 API 功能。...直接,直观地使用HTTP方法名称(操作)。 具有合理的默认值,功能强大的自定义。...Swagger / OpenAPI 我想要 Django REST Framework 的主要功能是自动 API 文档。...Marshmallow 一个由 API 系统所需的主要功能是数据的序列化,就是把数据编程语言中的对象转称成可以在网络上传输的对象,比如数据库的数据转换为 JSON 对象。

2.2K10

教你 10 分钟构建一套 RESTful API 服务( Django篇 )

实现 RESTful API 的实现过程 因此本篇将介绍 Django 搭建 RESTful API 的流程 ,使用的技术栈是:Django + djangorestframework + django-rest-swagger...的扩展,增加了对快速构建 REST API 的支持 django-rest-swaggerDjango 支持的Swagger UI,可以生成 API 接口文档 django-filter:配合 djangorestframework...完成数据过滤需求 # 安装依赖 pip3 install Django pip3 install djangorestframework # API 可视化 pip3 install django-rest-swagger...settings.py ,指定默认的数据库连接信息 # api/api/settings.py DATABASES = {     # 默认:Mysql数据库rest     'default...的 get_swagger_view() 函数,创建一个可视化的 API 界面 # api/api/urls.py from rest_framework_swagger.views import

5K10

django rest swagger

在周四的测试运维试听课程,芒果给大家介绍了契约测试,以及基于django rest framework 的 Swagger使用,这里我们来做个小总结。...Swagger的总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。当接口有变动时,对应的接口文档也会自动更新。...下面我们一起来看看基于Django rest API开发的rest framework Swagger的使用。...Django REST Swagger 在我们接口开发完之后,需要交付给别人对接,在没有使用swagger的时候,我们需要单独编写一份api接口文档,由postman之类的工具进行请求得到返回的结果。...Django REST Swagger安装: pip install django-rest-swagger Django REST Swagger配置: 在项目配置文件setting.py添加: INSTALLED_APPS

68110

简化 Django 开发的八个 Python 包 | Linux 中国

◈   describe_form 输出模型的表单定义,可以粘贴到   forms.py 文件。(需要注意的是,这种方法创建的是普通 Django 表单,而不是模型表单。)...处理 Django REST 框架的用户认证:django-rest-auth  如果 Django 开发涉及到对外提供 API,你很可能用到了 Django REST Framework[22](DRF...Django REST 框架的 API 可视化:django-rest-swagger  Django REST Swagger[23] 提供了一个功能丰富的用户界面,用来和 Django REST 框架的...你只需要安装 Django REST Swagger,把它添加到 Django 项目的已安装应用,然后在 urls.py 添加 Swagger 的视图和 URL 模式就可以了,剩下的事情交给 API...django-rest-swagger API 视图中的 docstrings 生成每个端点的文档,通过这种方法,为你的项目创建了一份 API 文档,这对你,对前端开发人员和用户都很有用。

2.9K20

ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

那么有没有一种快速有效的方法来构建api说明文档呢?答案是肯定的, Swagger就是最受欢迎的REST APIs文档生成工具之一!...Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。 Swagger 文件可以在许多不同的平台上代码注释自动生成。 Swagger 有一个强大的社区,里面有许多强悍的贡献者。...“管理 NuGet 程序包”对话框: 右键单击“解决方案资源管理器” > “管理 NuGet 包”的项目 将“包源”设置为“nuget.org” 在搜索框输入“Swashbuckle.AspNetCore...方法的服务集合: //注册Swagger生成器,定义一个和多个Swagger 文档 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new...生成的描述终结点的文档显示如下json格式。 ? 可在 http://localhost:/swagger 找到 Swagger UI。

3.2K10

POSTMAN自动生成接口文档_swagger自动生成接口文档

介绍 drf-spectacular是为Django REST Framework生成合理灵活的OpenAPI 3.0模式。...它可以自动帮我们提取接口中的信息,从而形成接口文档,而且内容十分详细,再也不用为写接口文档而心烦了 这个库主要实现了3个目标 DRF中提取更多的schema信息 提供灵活性,使schema在现实世界可用...(不仅仅是示例) 生成一个与最流行的客户端生成器配合良好的schema 环境准备 Python >= 3.6 Django (2.2, 3.1, 3.2) Django REST Framework...中排除操作 operation:手动覆盖自动发现将生成的内容。...methods:检查extend_schema特殊的方法,默认匹配所有 versions:检查extend_schema特殊的API版本,默认匹配所有 example:将请求/响应示例附加到操作

2.2K20
领券