文章/答案/技术大牛

发布

社区首页 >问答首页 >OpenAPI添加额外的示例，而不必重新定义默认示例

问OpenAPI添加额外的示例，而不必重新定义默认示例
EN

Stack Overflow用户

提问于 2020-10-18 04:25:44

回答 1查看 167关注 0票数 1

在OpenAPI 3中，我有一个响应块，它引用了一个现有的模型。

responses:
    200:
      description: successful operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MyModel'

因为MyModel包含example字段，所以我在UI中得到了一个很好的示例响应。可爱的。

我想向这个端点添加一些额外的例子。

我可以创建一个examples字段(在application/json下面)，并通过一个不错的UI下拉列表显示多个示例。但是，如果我这样做了，我就松开了默认示例，并且必须重新定义默认示例，以便用户查看。

我只能定义一组全新的例子，而不是添加一个新的例子。

在定义示例块以直接包含默认示例时，是否有一种方法？

我希望像这样的东西能起作用。

examples:
    default:
       $ref: '#/components/schemas/MyModel'
    myOtherExample:
       value: {"A": "B"}

它编译OK，但显示一个空示例。

swagger-ui

openapi

swagger

回答 1

Stack Overflow用户

发布于 2020-10-19 08:32:09

在定义示例块时是否有一种直接包含默认示例的方法？

这是不支持的。如果自定义example或examples是在OpenAPI定义中提供的，Swagger将使用这些自定义示例而不是自动生成的示例。

用户仍然可以在Swagger中的Model/Schema选项卡上看到模式文档中的默认值。

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/64413274

复制

Django REST Framework-如何使用分页

django

在 Web 开发中，处理大量数据是非常常见的。但是，如果一次性返回所有数据，不仅会增加服务器的负担，而且还会影响客户端的响应时间。为了解决这个问题，分页被广泛应用于 Web 应用程序中，特别是在 RESTful API 中。

玖叁叁

2023/04/25

2.1K1

第 6 篇：分页接口

node.js github git 开源 api

如果没有设置分页，django-rest-framework 会将所有资源类表序列化后返回，如果资源很多，就会对网站性能造成影响。为此，我们来给博客文章列表 API 添加分页功能。

HelloGitHub

2021/05/14

6700

Django REST framework初次使用

api python php 数据库 sql

我们将使用 django-rest 创建一个简单的API，以允许管理员用户查看和编辑系统中的user和group。

用户4945346

2020/06/16

7360

python测试开发django-rest-framework-86.分页查询功能(PageNumberPagination)

api 编程算法 http django node.js

当查询出来的数据量非常大的时候，需要分页查询，django-rest-framework 提供了分页的支持。有三种分页功能：PageNumberPagination，LimitOffsetPagination，CursorPagination。

上海-悠悠

2021/02/03

1.2K0

Django REST Framework-类视图（三）

django

ModelViewSet是一个基于视图集的通用类，提供了处理CRUD操作的通用功能。它继承自GenericAPIView和ViewSetMixin，提供了以下方法：

玖叁叁

2023/04/24

3100

Django REST Framework-类视图（二）

django

除了APIView类之外，DRF还提供了许多其他的类视图，以便我们更方便地编写代码和扩展API。以下是其中的一些：

玖叁叁

2023/04/24

2920

Django REST Framework-类视图（一）

django

Django REST Framework提供了许多内置的视图来处理不同类型的请求。其中一种是类视图，类视图是一个基于类的视图，可以继承DRF的APIView类或其子类。类视图提供了更多的灵活性和可重用性，可以更容易地组织代码和扩展API。

玖叁叁

2023/04/24

3180

Django REST Framework

python django

Django REST Framework 1. REST 前后端分离 API-ApplicationProgrammingInterface 为了应付千变万化的前端需求 REST:RepresataionsStateTrans 20000 Fieding博士提出 RESTful：遵守REST规范的技术设计的软件可以称为RESTful REST规范 URL代表一个资源，一个资源应该是一个名词动作有HTTP的methode方法提供 URL应该包含版本信息，版本信息也可以放在HTTP协议中过滤信息，使用UR

ruochen

2021/07/22

2.2K0

Django Rest Framework

django

https://q1mi.github.io/Django-REST-framework-documentation/

vanguard

2020/07/07

2.3K0

Django REST framework+Vue 打造生鲜超市（五）六、商品类别数据展示

django 数据库

六、商品类别数据展示 6.1. 商品类别数据接口（1）商品分类有两个接口：一种是全部分类：一级二级三级一种是某一类的分类以及商品详细信息：开始写商品分类的接口（2）序列化给分类添加三

zhang_derek

2018/04/13

2.4K0

六、商品类别数据展示

其他

90后小陈老师

2018/10/01

1.6K0

drf分页器

node.js php

也可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明。例如：

仙人技术

2020/07/14

8311

django rest_framework使用jwt

json python django

jwt 不是 rest_framework自带的认证方式，需要通过第三方库djangorestframework-jwt结合使用

编程黑洞

2023/03/06

4860

Django REST Framework-分页（一）

django

在 Web 应用程序中，当我们从数据库中检索大量数据时，为了避免一次性返回所有数据，通常需要将数据分成多个页面。这就是分页的基本概念：将数据分成多个页面，每个页面包含一定数量的数据。

玖叁叁

2023/04/25

2980

8.寻光集后台管理系统-用户管理(增删改查)

http

在完成了登录和注册视图之后，需求中还需要管理员可以管理用户列表，所以就需要完成基础的增删改查操作

zx钟

2022/12/02

1.9K0

Django REST Framework-常用的类视图

django

Django REST Framework是基于Django的一个用于构建Web API的框架。它提供了许多用于构建Web API的工具和实用程序，其中最常用的是类视图。类视图是一种Django REST Framework的API视图，它是基于类的视图。它提供了一种方便的方式来编写可重用的Web API视图，并带有许多有用的内置功能。

玖叁叁

2023/04/24

7180

DRF框架学习（四）

php 网站

重写 get_serializer_class和get_queryset,根据不同的操作返回不同的序列化器类和不同的查询集。

小闫同学啊

2019/07/18

2.8K0

Django REST framework初识

django 网站 api json php

现在工作中用的就是 django-rest 框架，今天主要讲下 django-rest 是个什么东西，为什么会使用它。准确的说 django-rest 是 django web 框架的一个插件，透过Django REST framework( DRF ) 建立 REST API 非常方便快速。现在的常见的开发的模式是前后端分离模式，页面是由前端工程师使用vue、 react等前端框架编写，接口由后端工程师通过其他框架编写，简单来说，前端工程师负责页面渲染，后端工程师负责接口，为前端页面提供数据。这样前后端都由各自擅长的工程师负责，不像很早之前，前后端由一个人编写。这样做的好处是各司其职，专业的人做专业的事。开发效率也很高效，因为django开发速度比较快，如果写api接口的话用django-rest和django很搭。

用户4945346

2020/06/16

6280

点击加载更多

相似问题

Django rest如何使用PageNumberPagination分页

Django Rest 'PageNumberPagination‘对象没有属性’页面‘错误

如果页码超出范围，Django PageNumberPagination自定义错误

如何在Django Rest框架中使用LimitOffSetPagination而不是PageNumberPagination？

以Django Rest Framework / JSON格式向关系添加属性

添加站长进交流群

领取专属 10元无门槛券

AI混元助手 在线答疑

关注 腾讯云开发者公众号

洞察 腾讯核心技术

剖析业界实践案例

问OpenAPI添加额外的示例，而不必重新定义默认示例
EN