openapi 相关问题

OpenAPI规范(最初称为Swagger规范)是用于描述,生成,使用和可视化RESTful Web服务的机器可读接口文件的规范。

Spring-Boot OpenAPI - @RestControllerAdvice 不限于抛出异常的方法

我需要用 OpenAPI 记录我的 SpringBoot API 及其可能的异常, 我正在使用 SpringDoc-OpenAPI https://springdoc.org/。 为了处理 NotFound 情况,我创建了这个异常类...

回答 2 投票 0

如何在OpenApi Spring上添加不同的@Schema描述?

我在使用 OpenApi 和 Spring 定义 API 时遇到一些问题。我正在使用这个依赖项: org.springdoc springdoc-openap...

回答 2 投票 0

如何使用python提取突出显示的文本以及与该突出显示的文本相关的注释?

举个例子,假设我有一个 pdf 文件,其中突出显示的文本显示“售价 100 美元”,并且该突出显示的文本附加了一条评论,显示“替换为 9 美元...”

回答 1 投票 0

Python Pyramid 应用程序的 Swagger 文档

我有一个旧的Python金字塔Web应用程序,我只想为其创建一个API文档(特别是Swagger或OpenAPI3)。有没有办法在不写整个招摇的情况下做到这一点......

回答 2 投票 0

有没有办法在azure函数v3中隐藏openapi的模式?

我有一个带有 openapi 配置的函数应用程序,我想禁用模型部分 我在项目中配置了openApi 公共静态异步任务 Main() { var host = 新的 HostBuil...

回答 2 投票 0

java OpeApiPlugin - 未提供 API 定义 - withDefinitionConfiguration BiConsumer 不会被调用

总体问题是我的 swagger-ui(现在是 OpenAPi)不会使用所有 api 端点呈现 swagger-ui 页面。 错误提示“未提供 API 定义”。 我的 eclipse gradle pro...

回答 1 投票 0

FastAPI 和 GCP API 网关

我有一个使用 OpenAPI 3.0 在 FastApi 中开发的后端。它托管在 GCP Cloud 中。 FastAPI 是自动记录的(Swagger UI),并且暴露在互联网上。 现在,我正在

回答 1 投票 0

Swagger UI 中 allOf 的 OpenAPI 文档重复问题

我正在制定 OpenAPI 3.0 规范,并且在 Swagger UI(或任何类似工具)中生成的文档遇到问题。具体来说,我使用 allOf 构造来继承

回答 1 投票 0

多态性中的“鉴别器”,OpenAPI 2.0(Swagger 2.0)

参考OpenAPI 2.0 Schema Object或Swagger 2.0 Schema Object,鉴别器字段的定义为: 添加对多态性的支持。鉴别器是架构属性名称...

回答 2 投票 0

如何在 Open API 3.0 中为 GET API 定义 Map 对象

我有 GET API,它将 Map 作为请求参数。如何在 Open API 3.0 中以 yaml 格式定义它 @GetMapping public void getDevicesInfo(@RequestParam(required = false) 映射参数) { } ...

回答 2 投票 0

OpenAPI - 从外部文件引用路径

我正在尝试使用 swagger-ui-express 和 yaml 包来记录我的expressJS API以解析yaml文件。 这是我的文件结构的相关部分: └── 文档   ├── 测试.yaml    └── openapi.yam...

回答 1 投票 0

Spring boot Swagger 3 - OpenApi 文档中默认不显示控制器摘要

默认情况下,API 方法名称在 Swagger2 中显示为摘要 但是,默认情况下,OpenApi3 中不显示。 我该如何配置这个属性?不使用 @Operation(summary = "Summ...

回答 2 投票 0

如何在`map`对象中编写OpenAPI 3 (Swagger)规范的属性名称?

我试图描述的 API 具有一个结构,其中根对象可以包含任意数量的子对象(属性本身就是对象)。 “钥匙”,或

回答 1 投票 0

在 NET8 Web API 项目中的 swagger 中使用来自外部源的 JSON 模式

NET8 Web API 项目。 我的控制器操作没有键入的输入参数。传入的 JSON 是从请求正文流中读取的,并使用 NJsonSchema 根据架构进行验证,然后发送...

回答 1 投票 0

OpenApi 使用 JSON 发送 MultipartFile 请求,不支持获取“应用程序/八位字节流”错误

我正在使用 Spring Boot,我想使用 Swagger UI 发送带有 json 的 MultipartFile,但如果我使用 Postman 工作得很好,我会收到错误“application/octet-stream”不支持错误。 @ResponseBo...

回答 2 投票 0

OpenApi 使用 JSON 发送 MultipartFile 请求

还有比这更好的解决方案吗(OpenApi 发送带有 JSON get 'application / octet-stream' 错误的 MultipartFile 请求不支持)吗? @PostMapping(路径 = "", 消耗 =

回答 1 投票 0

Swagger/openapi 将 @Schema(description) 添加到每个枚举值

我正在使用 Swagger/OpenApi V3 注释创建应用程序的 API 描述,从以下依赖项导入: org.springdoc ...

回答 1 投票 0

如何在 OpenAPI (Swagger) 中定义一个可以是字符串或 null 的属性?

我有 JSON 架构文件,其中属性之一定义为字符串或 null: “类型”:[“字符串”,“空”] 当转换为 YAML(与 OpenAPI/Swagger 一起使用)时,它将变为: 类型: - 'n...

回答 1 投票 0

取决于 URL 路径参数的条件 JSON 模式

我正在尝试编写一个开放的api文档,涉及路径中带有参数的PUT请求,例如PUT /settings/{settingId} 我希望 JSON 有效负载是简约的,看起来像这样......

回答 1 投票 0

如何使用 swagger OpenAPI 注释为字段设置描述

为了改进我们的 api 文档,我想向响应正文的字段添加描述 作为示例,请参阅此处的默认 petstore 规范:https://editor.swagger.io/ 在帖子/宠物中 在宠物中

回答 2 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.