openapi 相关问题

规范测试不会将承载令牌发送到服务器

我在尝试使用 Specmatic 测试 API 合约时遇到问题。问题是，当我启动 Specmatic 的测试模式时，它不使用我为测试提供的不记名令牌。我试过了

Openapi 使用 JSON Schema 实现包含字典作为参数之一的函数调用

说明 我目前正在使用 openapi 和 python 开发一个游戏项目。下面给出了我编写的函数调用之一。 获取案例文件 { “名称”：“getCaseFile”...

如何在 OpenAPI (Swagger) 中将 $ref 属性声明为只读？

我试图在此示例中为“House”添加一个只读字段。房子是另一个我想要只读的模型。 在此示例中，可以将 Dogs 数组设置为只读而不会出现错误...

升级到开放api 3渲染超过所需的实体和api

我正在使用带有 Spring Boot 应用程序的开放 API。最近，该应用程序从 java 11 升级为使用 java 17，从那时起，API 停止工作。我将其升级为打开 api 3 以下...

从 HttpContext 读取 DTO 在 JSON 反序列化中返回 null（nswag 生成的客户端）

我正在深入研究 NET8、最小的 API 和干净的架构。 首先：这有效（Swagger UI 和邮递员） app.MapPost("/user/login", async (HttpContext httpContext, [FromBody] LoginDto

如何使用 Swagger 正确记录字符串化 JSON？

在与 ChatGPT 争论这个问题之后，我怀疑我想要实现的目标是不可能的，但希望还没有完全消失。 我有一个 API 端点，它返回一个 JSON 响应，其中包含...

如何在 OpenAPI 中定义 json-lines 响应？

有没有办法用 OpenAPI 描述 json-lines ？ 除了似乎还没有 MIME 类型这一事实之外，我想知道是否可以描述这样的响应。 理论上我的反应...

向 OpenAPI 3.0.x 中的现有响应架构添加新属性

我有四个路径a、b、c、d。所有路径以前都具有相同的属性和模式。现在有一个新的要求，路径c和d将在名为rex的属性中发生变化。定位很重要...

如何使用nswag生成openapi.json

我正在使用 nswag 来生成 swagger。但是 openapi json 文件仅在内存中，您只能通过启动应用程序并导航到链接 swagger/v1/swagger.json 来访问它。 我想要...

如何在Springdoc-openapi中的模式示例中设置值null而不是“null”？

我正在使用 Springdoc-openapi 并有一个像这样的 dto： @Schema(标题 = "财务状况") @JsonIgnoreProperties（ignoreUnknown = true） 公共类当前财务条件{ @

如何使用 io.swagger.core.v3:swagger-jaxrs2 始终生成具有相同元素顺序的 yaml？

我需要为我的应用程序生成 yaml 文件，但我需要每次生成它时都相同，以便将当前生成的 yaml 与 API 的当前状态进行比较。 但我是

在 dart-dio openapi 生成的代码中设置 Api 密钥

我使用 openapi-generator-cli 和 dart-dio 生成器创建了一个 API。 我的 Api 需要带有 API 集的 apikey 标头。 目前，如果我设置 apikey 标头，我可以从 api 获取数据...

覆盖 OPEN API 3.0 中的特定属性

我有四个路径a、b、c、d。所有路径以前都有相同的属性和模式。现在有一个新的要求，路径c和d将在名为rex的属性中发生变化。定位很重要...

在 FastAPI 中自动生成列表查询参数的 API 文档

FastAPI 不会为具有数组查询参数的查询生成文档。即： GET /items?filter[name]=foo&filter[category]=bar&sort=-id,name。 根据 Openapi 3.0 文档，他们支持

哪里可以找到 GitLab API v4 Swagger/OpenAPI 规范？

我正在寻找 GitLab API 版本 4 (/api/v4/) 的 Swagger/OpenAPI 规范文件。我进行了大量搜索但找不到。 有人可以指出我正确的方向或专业人士吗...

docker 容器中的 spring-boot swagger-ui 返回 404

我想将我的 spring-boot 应用程序部署到 docker 容器中。 我有一个本地工作的应用程序，我的 swagger ui 工作得很好。 因此，如果我在 docker 容器之外启动我的应用程序，o...

将 OpenAPI 架构枚举值标记为已弃用

是否可以在 OpenAPI 定义中将特定枚举值标记为已弃用？ 例如，如何将 Value1 标记为已弃用？ 类型：字符串 标题：自定义枚举 枚举： - 值1 - 价值2

在 Swagger UI 中屏蔽输入（示例 - 密码）？

我有一个 API 的三个路径变量。我想用 ***** 屏蔽 Swagger UI 上的一个输入。 使用 Springdoc OpenAPI 时如何做到这一点？

标题：无法在 Spring Boot OpenAPI 文档中显示 LocalDateTime 字段的示例值

我使用 Spring Boot 3 并具有以下 OpenApi 依赖项： 2.1.0 org.springdoc 我使用 Spring Boot 3 并具有以下 OpenApi 依赖项： <version.springdoc.openapi>2.1.0</version.springdoc.openapi> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>${version.springdoc.openapi}</version> </dependency> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-api</artifactId> <version>${version.springdoc.openapi}</version> </dependency> 我正在使用 Springdoc OpenAPI 库 2.1.0 版本开发 Spring Boot 应用程序。在我的项目中，我有一个模型类，其中包含 LocalDateTime 类型的字段，并且我尝试使用 @Schema 注释为此字段指定示例值。但是，尽管在注释中设置了示例值，生成的 OpenAPI 文档仍然显示默认字符串($date-time)，而不是提供的示例。 这是我如何在模型类中使用 @Schema 注释的示例： import io.swagger.v3.oas.annotations.media.Schema; import java.time.LocalDateTime; public class YourModel { @Schema(description = "Event date and time", format = "date-time", example = "2022-12-31T23:59:59") private LocalDateTime creationDateTime; // Getters and setters } 我已经验证我的依赖项是否已正确配置，并且我正在使用的 Springdoc OpenAPI 库版本应该支持为架构属性指定示例值。 任何关于如何解决此问题并让示例值在生成的 OpenAPI 文档中正确显示的建议将不胜感激。谢谢你。 您可以使用@Schema的“type”定义将自定义格式显示为字符串： @Schema(description = "Event date and time", type = "string", example = "2022-12-31T23:59:59") private LocalDateTime creationDateTime;

将 json 解组到具有 oneof 类型的 protobuf 中

我正在开发一些API定义符合openapi 3.0.0的东西 根据 openapi 3.0.0，oneOf 类型字段可以采用上述任何一种类型的值。 宠物： 其中之一： - ...