openapi相关内容

如何在不运行应用程序的情况下使用nestjs生成openapi规范

我们有很多用NodeJS编写的API，使用的是nestjs框架。 我们可以使用SwaggerModule从nestjs生成openapi.yaml。这很好用。但问题是它需要API启动，因此数据库已经启动并运行。这对我们的CI/CD来说是个问题，因为我们需要在运行API之前生成openapi规范。 是否可以从我们的代码生成openapi规范，而无需运行应用程序？ 或者有没有一种简单的方法来模拟我们 ..
发布时间：2022-03-07 10:37:29 其他开发

如何集成不同API的openapi规范？

我想问问有没有办法轻松聚合不同接口的OpenApi规范？ 我们当前为每个API使用Swagger，在那里我们添加了用于身份验证的自定义逻辑，我们还为不同的辅助功能规则添加了规则。 但是，以某种方式聚合所有这些API并将身份验证和访问逻辑放在同一位置会方便得多。 示例： 我们有两个独立的微服务，具有独立的API和独立的地址 API 1本地主机：5000 使用Ord ..
发布时间：2022-02-28 11:31:45 其他开发

Swagger/Openapi-Annotations:如何使用 $ref 生成 allOf?

我正在生成 Rest 端点，包括向生成的代码添加 Openapi/Swagger 注释. 虽然它适用于基本类型，但我对自定义类有一些问题. 现在我有很多自定义类的重复架构条目(使用 @Schema(implementation = MyClass.class))，但至少需要的信息在那里.不过，我想找到一种方法来删除重复的架构条目，同时保留其他信息. 在讨论 $ref 和缺少兄弟属 ..
发布时间：2022-01-22 18:35:27 Java开发

如何在 swagger 规范中表示十进制浮点?

我想在我的 api 文档中用 2 位表示小数，用 1 位表示小数.我正在使用 swagger 2.0，规范中是否有内置定义类型或任何其他“圆形"参数，或者我唯一的选择是使用“x-"扩展名? 解决方案 OpenAPI (fka Swagger) 规范使用 JSON Schema 来描述数据类型. 如果参数作为数字传递，您可以尝试使用 this Q& 中建议的 multipleOf一个: ..
发布时间：2022-01-22 18:32:51 其他开发

如何使用 OpenAPI (Swagger) 描述多部分响应?

我有一项服务可以创建包含以下内容的多部分文件: 表示图像缓冲区的数据字节数组 表示图像信息(坐标、格式等)的 JSON 是否可以使用 YAML 在 OpenAPI (Swagger) 定义中对此自定义响应进行建模? 解决方案 可以使用 OpenAPI 3.0 描述多部分响应，但不能使用 OpenAPI 2.0 (fka Swagger 2.0). openapi: 3.0. ..
发布时间：2022-01-22 18:25:51 其他开发

如何在整个 Swagger YAML 文档中重复使用我的 x-amazon-apigateway-integration 定义?

我目前正在使用 Swagger 定义具有许多端点的 API，并且这些端点中的每一个都对“x-amazon-apigateway-integration"键具有相同的定义.我想在文档中的某个地方定义它，并在整个过程中重复使用该定义. 要么我不明白定义应该如何定义，要么我没有将它放置在正确的位置或两者的混合.我尝试在“定义"中定义这个定义，并在它自己的键下定义一些别名.定义(删除关键信息)是: ..
发布时间：2022-01-22 18:25:43 其他开发

嵌套对象中的 OpenApi 必需属性不起作用

我需要描述一个 api，它在请求正文中有一个带有必填字段的对象，其中一个字段是一个对象本身，它具有另一组必填字段. 我正在使用 open api v3 和 swagger 编辑器 (https://editor.swagger.io/)在我将 .yaml 文件放到编辑器上后，我生成了一个 html 客户端(> 生成客户端 > html).然后我打开在获取此架构的 .zip 文件中生成的静态页 ..
发布时间：2022-01-22 18:24:25 其他开发

告诉 Swagger 请求正文可以是单个对象或对象列表

我正在使用 Swagger 和 Scala 来记录我的 REST API.我想为 POST、PUT 和 DELETE 启用批量操作，并希望相同的路由接受单个对象或对象集合作为正文内容. 有没有办法告诉 Swagger 参数是 A 类型值的列表或 A 类型的单个值? 类似于 REST 的可变参数. 解决方案 有没有办法告诉 Swagger 参数是 A 类型值的列表或 A 类型 ..
发布时间：2022-01-22 18:23:13 其他开发

如何在 OpenAPI 3.0 中定义标头参数?

在 OpenAPI (Swagger) 2.0 中，我们可以像这样定义标头参数: 路径:/邮政:邮政:参数:- 在:标题名称:X-用户名 但在 OpenAPI 3.0.0 中，参数被请求体替换，我找不到定义标头参数的方法，这些参数将进一步用于身份验证. 在 OpenAPI 3.0.0 中定义请求标头的正确方法是什么? 解决方案 在 OpenAPI 3.0 中，header 参数的 ..
发布时间：2022-01-22 18:22:00 其他开发

使用 Django Rest Framework 对 OpenAPI 端点进行自定义分组

我有一个 Django 项目，我正在使用 Django REST 框架.我正在使用 drf-spectacular对于 OpenAPI 表示，但我认为我的问题与这个包无关，对我来说这似乎是一个更通用的 OpenAPI 的东西(但不是 100% 确定我是否正确). 假设我有这样的 URL 结构: urlpatterns = [路径('admin/'，admin.site.urls)，路径(' ..
发布时间：2022-01-22 18:20:08 其他开发

通过 Swagger/OpenAPI 为附加属性指定多种类型

我希望在 OpenAPI 中表示以下 JSON 对象: {“名称":“鲍勃"，“年龄":4，...} 属性的数量和属性名称没有完全预先确定，所以我希望使用附加属性.但是，我不太确定它将如何通过 OpenAPI/Swagger 2.0 表示.我试过这个: 人员:类型:对象附加属性:类型:- 整数- 细绳 或等效的 JSON: {“人": {“类型":“对象"，“附加属性":{“类型":[“ ..
发布时间：2022-01-22 18:19:23 其他开发

从 typescript 接口生成 swagger 文档

我正在使用 swager-jsdoc 来记录应用程序的所有 DTO. 我想知道有没有办法从 typescript 接口自动生成 swagger 文档. 我在项目中有很多，还有很多猫鼬模式和模型.让它们保持同步变得越来越乏味.另一方面，我不想使用 swagger 生成工具.我更喜欢自下而上的方法. 干杯 解决方案 tsoa 的另一个选项是 路由控制器 + 路由-控制器-op ..
发布时间：2022-01-22 18:18:05 其他开发

如何在 Swagger open api 3.0 中定义常量字符串

swagger open api 3.0 中如何定义常量字符串变量?如果我定义枚举，它将如下所示 “状态码":{"title": "状态码",“枚举":[“成功"，“失败"],“类型":“字符串"} 但是枚举可以是值列表，有没有办法在swagger open api 3.0中定义字符串常量 代码可以从 http://editor.swagger.io/ 执行 解决方案 正如@Hel ..
发布时间：2022-01-22 18:17:56 其他开发

swagger 安全方案对象的“范围"字段用于什么?

petstore_auth:类型:oauth2授权网址:http://swagger.io/api/oauth/dialog流:隐式范围:write:pets: 修改你账户里的宠物阅读:宠物:阅读你的宠物 这是来自Swagger 规范 的安全定义示例.write:pets 和 read:pets 的用途是什么?这是路径的一些类别吗? 解决方案 write:pets 和 read:pets ..
发布时间：2022-01-22 18:16:25 其他开发