首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    drf的接口文档生成与管理

    (Swagger升级版) 4.1 drf-yasg介绍 4.2 安装drf-yasg库 4.3 配置app 4.4 配置路由url 4.5 访问查看 4.6 更多配置及说明 4.6.1 get_schema_view...'LOGIN_URL': 'rest_framework:login', 'LOGOUT_URL': 'rest_framework:logout', # 控制API列表的显示方式 None...': True, # 切换使用Django Auth作为身份验证机制 将其设置为True将会在Swagger UI上显示一个登录/注销按钮,并将csrf_tokens发布到API 'USE_SESSION_AUTH...'rest_framework', 'drf_yasg' ] 4.4 配置路由url from rest_framework import permissions from drf_yasg.views...API Info对象, 具体定义详见 Swagger/OpenAPI 规范, 如果缺省, drf-yasg默认会用 DEFAULT_INFO 进行填充 url: 项目API的基础地址, 如果缺省, 则根据视图所在的位置进行推导

    4.8K10

    Django Swagger文档库drf-spectacular

    在使用DRF的时候,通常的文档有:默认文档RestFrameWork、CoreAPI、Swagger,Swagger是最流行的API文档库,在绝大多数服务端开发中都有用到,之前我们使用了CoreAPI来生成文档...methods:检查extend_schema中特殊的方法,默认匹配所有 versions:检查extend_schema中特殊的API版本,默认匹配所有 example:将请求/响应示例附加到操作中.../authentication.py文件中可以看到,这个的作用就是在文档中显示什么样认证页面 对于认证页面的显示,主要是根据settings.py配置中的 REST_FRAMEWORK = {...可以识别 DEFAULT_AUTHENTICATION_CLASSES 下的认证方式,就会在文档登录页面上显示对应的认证方式,这里我们有自定义的认证方式,如果需要显示,要做一下适配: from drf_spectacular.extensions...目前我采用的是第一种方式,宁愿API不明确一点,也不能增加后端的复制程度。

    2K20

    DRF框架中的英文单词

    DRF框架中的英文单词 1. prefix/'prifɪks/前缀,我们在路由配置的时候经常看见这个单词。在flask中,我们可以在设置url的时候为了区别视图,在类似功能的url全部加一个前缀。...2. version/'vɝʒn/版本,这个在计算机上面很常见,在DRF框架中的RESTful设计风格中有一种规范,就是将api的版本号放入url中,如下:(1.0即版本号) http://www.example.com...4. filter/'fɪltɚ/过滤,我们在DRF框架的高级功能中,就有过滤这一项。可以在url地址中传参数,我们进行过滤。 5....{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations...页面时,显示的字段名称 help_text 用于HTML展示API页面时,显示的字段帮助提示信息 24. instance/'ɪnstəns/实例,我们下面的这种情况下用到了: Serializer(

    1.7K30

    Django进阶:DRF(Django REST framework)

    什么是DRF? DRF即Django REST framework的缩写,官网上说:Django REST framework是一个强大而灵活的工具包,用于构建Web API。...简单来说:通过DRF创建API后,就可以通过HTTP请求来获取、创建、更新或删除数据(CRUD)。 那么为什么要构建API呢?...目前一种成熟的方法就是API。 那么什么是REST? 如果你对DRF是用于构建Web API的说法已经满意了,就可以跳过这段了。 那么什么是REST?...关于如何设计出符合REST风格的API,可以参考阮一峰的《RESTful API 设计指南》 那么用DRF实现的就是RESTful API吗?其实DRF没有强制实现。...可以发现,和Django程序相比,我们没有写template做前端的显示,而是写了序列化类提供API。前端可以分离出来,使用API来和后端通信。

    64020

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

    它可以自动帮我们提取接口中的信息,从而形成接口文档,而且内容十分详细,再也不用为写接口文档而心烦了 这个库主要实现了3个目标 从DRF中提取更多的schema信息 提供灵活性,使schema在现实世界中可用...然后在settings.py的INSTALLED_APPS安装drf-spectacular INSTALLED_APPS = [ # ALL YOUR APPS 'drf_spectacular...', ] 最后向DRF注册我们壮观的AutoSchema REST_FRAMEWORK = { # YOUR SETTINGS 'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema...'), # Optional UI: path('api/schema/swagger-ui/', SpectacularSwaggerView.as_view(url_name='schema...'), name='swagger-ui'), # swagger接口文档 path('api/schema/redoc/', SpectacularRedocView.as_view(url_name

    2.4K20

    第 16 篇:别再手动管理接口文档了

    反过来,这些信息也就可以定义一个完整的 RESTful 风格的接口: 请求的 HTTP 方法和 URL。...可以看到内容大体上是正确的,接口基本上都罗列了出来,但是仔细检查各个接口的内容,就会发现一些问题: GET /api-version/test/ 这个接口是我们用来测试的,不希望它显示在文档里。...前者文档中显示了一些错误的参数,后者本应该有分页参数,但是文档却没有列出。...二是 GET /posts/archive/dates/,这个接口的返回内容应该是一个日期列表,但是文档中显示的竟然是博客文章列表。drf-yasg 推断的响应类型是正确的,但内容不对。...: https://github.com/axnsan12/drf-yasg [6] OpenAPI Specification: https://swagger.io/resources/open-api

    1.8K20

    第 9 篇:实现分类、标签、归档日期接口

    url_name:接口名,主要用于通过接口名字反解对应的 URL。...而这个接口中只需要序列化一个时间字段(类型为 Python 标准库中的 datetime.date),所以没必要单独定义一个序列化器了,直接拿 django-rest-framework 提供的用于序列化时间类型的...from .models import Post class PostFilter(drf_filters.FilterSet): created_year = drf_filters.NumberFilter...由于这两个字段在 Post 中没有定义,Post 记录时间的字段为 created_time,因此我们需要显示地定义查询规则,定义的规则是: 查询参数名 = 查询参数值的类型(查询的模型字段,查询表达式...例如选择如下的过滤参数,得到查询的 URL 为: http://127.0.0.1:10000/api/posts/?

    2.6K30

    DRF自动生成OpenAPI文档

    DRF自动生成OpenAPI文档 API schemas是非常有用的,可以帮助我们生成接口文档以及可与API交互的动态客户端。...在这里我们使用drf-spectacular这个第三方库来自动生成OpenAPI schemas. drf-spectacular 安装,配置步骤可以参考drf-spectacular文档,下面简单的给出步骤...安装和配置 使用 经过上面的基本配置,我们现在访问api/schema/swagger-ui/来查看swagger-ui风格的文档,如下所示: 当你点击schema的时候,就会显示响应字段的描述...drf-spectacular自动生成文档,很大程度上依赖于文档字符串以及queryset和serializer_class(DRF的APIView没有这两个属性,对于APIView自动生成文档有困难,...= 'id' lookup_url_description = '书籍id' 上面这里方法和属性来自于下面的导入操作: from drf_spectacular.utils import extend_schema

    2.8K20

    Django rest Framework入门 二 :DRF框架初体验

    Django rest Framework入门 一 :手工实现常见API中记录了如何手工基于Django实现常见的API类型,这篇笔记记录一下DRF框架简单使用的体验。...笔记中提到的代码repo:https://github.com/yexia553/drf 安装和配置修改 安装DRF 安装drf之前要先安装Django pip install djangorestframework...:8000/books/2 当在浏览器中输入这个url的时候,实际上也是一个查询的API,但是是查询id为2的这一本书的信息; 不过当进入之后会看到页面右上角会有一个红色的DELETE按钮,这个按钮对应的就是...DELETE API; 页面的下半部分是一个表格,右下角有一个蓝色的PUT按钮,这个按钮对应的就是PUT API; 通过代码测试 test路径下有一个文件drf_first_seen.py,运行这个文件...,会返回每一个API测试成功或者的结果,如下: (venv): python drf_first_seen.py 测试查询具体书本信息API成功 测试创建书本API成功 测试查询所有书本信息API

    9810

    Django REST Framework 简介

    Django REST Framework(以下简称DRF)是基于Django框架的一个强大的Web API框架。...DRF可以轻松地与Django ORM和其他第三方库集成,这使得构建Web API变得非常简单。在DRF中,序列化器是一个重要的概念。...视图是DRF中的另一个关键概念。视图定义了API的行为,即如何响应请求、如何验证输入等。...这些视图可以轻松地处理常见的API功能,如CRUD操作、列表视图和分页等。DRF还提供了一组灵活的路由器,用于将URL映射到视图。...这些路由器可以轻松地处理基于视图的URL配置,使得API的维护和扩展变得非常简单。DRF还提供了灵活的身份验证(Authentication)和权限(Permission)系统,以确保API的安全性。

    87920

    Django REST Framework-什么是路由

    Django REST Framework(以下简称DRF)是一个强大的框架,用于在Django中构建Web API。路由(Routing)是DRF中的一个关键概念,用于确定请求的处理方式。...在DRF中,路由的作用是将特定的URL与处理该URL请求的视图函数相匹配。DRF中的路由系统是基于Django的URL路由系统构建的。...SimpleRouterSimpleRouter是DRF提供的最简单的路由器之一。SimpleRouter允许您使用DRF视图类作为视图函数来处理请求,并为每个视图类自动生成URL模式。...DefaultRouterDefaultRouter是DRF提供的另一个路由器。与SimpleRouter不同的是,DefaultRouter自动生成API根视图,并为每个视图类生成URL模式。...这将告诉DRF生成URL模式时使用的基本名称。

    47311
    领券