openapi 相关问题

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

使用 OpenApi 自定义错误响应消息/对象

我在前端和后端使用 OpenApi 生成器。 当我使用无效输入调用 api 时,我希望后端返回错误并提供有关无效输入的反馈。 错误状态代码 (HTTP

回答 1 投票 0

从 Swagger 编辑器发出请求时如何避免 CORS 错误(“无法获取”或“找不到服务器或发生错误”)?

我有以下 OpenAPI 定义: 昂首阔步:“2.0” 信息: 版本:1.0.0 标题:简单的API 描述:一个简单的API来学习如何编写OpenAPI规范 方案: - https 主持人...

回答 2 投票 0

Springboot openapi 在 swagger 文档中生成重复的 api

Java:21 弹簧启动:3.2.1 OpenApi依赖: org.springdoc springdoc-openapi-starter-webmvc-ui ...

回答 1 投票 0

Langchain neo4j 集成没有返回结果

我正在使用 langchain 和 neo4j Libs 将 NL 转换为 cypher。 一切正常,我什至得到了完成链,它显然不是空的 完整上下文: [{'d': {'name': '喹那普利', 'ID': 'CHEMBL1...

回答 1 投票 0

如何避免重复 API 架构以同时提供 XML 和 JSON?

我正在为具有标签集合的资源(文档)定义一个 API。每个标签可以是任何类型,并且每个标签类型定义一组不同的属性。 该文档的 XSD 看起来像

回答 1 投票 0

无法将 Pascal Casing 应用于 Swagger 输出

我已使用 Microsoft.Azure.Functions.Worker.Extensions.OpenApi 1.5.1 将 OpenAPI 添加到我的 .Net8 隔离 http 触发器 Azure Functions 这是我的主机构建器代码: var 主机 = 新的 HostBuilder() //.

回答 1 投票 0

如何使用 OpenAPI 定义未包装的 XML 响应

我想编写一个 RESTful Web 服务器,它提供以下 XML 文档: 我想编写一个 RESTful Web 服务器,它提供以下 XML 文档: <Services> <TileMapService title="TMS server" version="1.0.0" href="/tms/1.0.0"/> <TileMapService title="TMS server" version="1.0.1" href="/tms/1.0.1"/> </Services> 我使用 OpenAPI Generator Gradle Plugin 为我的 SpringBoot RestController 生成模型类。 openApiGenerate { generatorName = "spring" ... configOptions = [ withXml: "true", ... ] } 使用以下 openapi.yaml 规范文件: ... "paths" : { "/tms" : { "get" : { "operationId" : "getServices", "responses" : { "200" : { "content" : { "text/xml" : { "schema" : { "$ref" : "#/components/schemas/ServicesRoot" } } } } } } } }, "components" : { "schemas" : { "ServicesRoot" : { "xml" : { "name" : "Services" }, "properties" : { "TileMapServices" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TileMapService" } } } }, "TileMapService" : { "xml" : { "name" : "TileMapService" }, "properties" : { "title" : { "type" : "string", "xml" : { "attribute" : true } }, "version" : { "type" : "string", "xml" : { "attribute" : true } }, "href" : { "type" : "string", "xml" : { "attribute" : true } } } }, ... 生成器根据此规范创建一个 ServicesRoot 模型类。当我将此模型与 RestController 一起使用来创建响应时,我得到: <Services> <TileMapServices> <TileMapServices title="TMS server" version="1.0.0" href="/tms/1.0.0"/> <TileMapServices title="TMS server" version="1.0.1" href="/tms/1.0.1"/> </TileMapServices> </Services> 您能帮我解决以下问题吗: TileMapService 数组项包装在 <TileMapServices> XML 元素内。我需要在 </Services> 父 XML 元素中“展开”数组项。 数组项 XML 元素名称“复数”为 <TileMapServices .../>,并带有尾随“s”。 我想使用生成的模型类作为 RestController 的响应对象,并使用 Jackson XMLMapper 来序列化 XML 文档。 所以你的服务正在返回 JSON。我的答案假设 Java 和 Spring Boot 基于您使用 Gradle 和生成器。 要获取 XML,请看一下:Spring-boot 从控制器返回 json 和 xml 它显示了要添加到项目中以进行 XML 输出和相关配置的 Maven/Gradle 依赖项。 要“调整”编组,您需要使用类似的东西 @JacksonXmlElementWrapper(useWrapping = false) 或 @JsonProperty("X") 有关这方面的一些指导,请参阅:https://www.baeldung.com/jackson-xml-serialization-and-deserialization。 您可能需要创建一个特定的 DTO 来返回,而不是内部模型,以便使用上述注释更直接地控制编组。 希望这能让您开始。 我很抱歉。我误读了你的帖子。 你看到这篇文章了吗: 如何在OpenAPI 3.0中定义对象数组? 其中,他们使用“unwrapped”。 components: schemas: abc: xml: wrapped : true <<--- here! name: abc type: array items: type: object xml: name: 'item' properties: Name: type: string age: type: integer enabled: type: boolean example: - Name: no1 age: 18 enabled: true - Name: no2 age: 20 enabled: false

回答 1 投票 0

使用 OpenAPI 工具时出现“第 1 行第 17 列错误:媒体类型无效:预计不再有输入”

我正在使用来自 Github 的以下 OpenApi 工具:OpenApi-generator 它根据 YAML 文件自动生成类。我将这些类集成到我的 Flutter 项目中并希望使用它们。我

回答 1 投票 0

如何将作者放入 swagger 编辑器中?

我最近记录了我的 API,我需要指定作者才能使其可用。如果有人可以帮助我,我将非常感激。我使用OpenAPI(swagger编辑器)3.0 我尝试查看官方

回答 1 投票 0

在公共端点上获取锁定符号以及在 swagger 中

当在 Spring Boot 中使用 swagger 和 JWT 作为安全性时,我也得到了开放端点的锁定符号。 在 pom.xml 文件中为 Swagger (OpenAPI) 添加了依赖项: ...

回答 1 投票 0

从公共服务中删除挂锁图标 Spring boot openapi v2 swagger

根据你看到的图片我有几项服务。其中一些需要授权,但有些是不需要授权的公共服务。但在 Swagger UI 中,所有服务都...

回答 1 投票 0

如何将自定义错误消息添加到 openapi 中自动生成的字段

如果我有一个 openapi 模式,其中包含以下条目 必需的: - 姓 特性: 姓: 类型:字符串 我得到生成的代码,例如 @NotNull() @Schema(name = "lastName&quo...

回答 1 投票 0

ASP.Net Open Api 指定端点部分

我通过最小的 api 生成端点,并尝试使用 Microsoft.AspNetCore.OpenApi 包生成文档,但我不知道如何设置一个部分,并且我的所有端点都出现在 sin...

回答 1 投票 0

L5-swagger api 文档:获取错误必需的 @OA\PathItem() 未找到

阅读 Stackoverflow 上的这两篇文章后: 如何解决 ErrorException:未找到必需的 @OA\PathItem() 无法在l5-swagger中生成API文档 我仍然收到错误必需...

回答 4 投票 0

Swagger-php:如何启用详细检查排除的目录?

使用 Swagger-php 和以下命令,我怎样才能让它显示它搜索的文件夹/文件,以便我可以检查我的 exudes 是否实际工作? $openapi = \OpenApi\scan('./myfolder', [ '排除...

回答 2 投票 0

如何从 jsonresult 响应自动生成 OpenAPI 文档?

Swashbuckle可以根据代码自动生成API文档(有详细返回模型) [http获取] 公共 ActionResult> GetStudents() { 返回 CollegeReposi...

回答 1 投票 0

如何通过“隐藏”POST 字段记录 PUT

我正在尝试使用 swagger 来记录 API,但我很难弄清楚如何记录通过使用 POST 和所谓的隐藏 _method 参数来工作的 PUT/DELETE 方法,该参数表明...

回答 1 投票 0

用于 PHP 数组的 Swagger

我正在尝试创建一个响应示例,该示例应返回如下数组: [ [ “店铺名称”, “53.7094190”, “-1.9084720” ,1 ] ] 为此,我使用以下代码: * @OA\Res...

回答 2 投票 0

无法从 Gitlab 内的 Swagger UI 调用外部 API。内容安全策略错误

我正在尝试在 GitLab 中使用 OpenAPI 文件(它为我的文件运行 UI),但是当我使用从 Swagger UI 尝试/执行功能(它向外部 API 发送请求)时,我收到错误与

回答 2 投票 0

使用jjwt的java springboot项目中的SwaggerUI不断抛出403状态代码

我有一个 java springboot maven 项目,我想要某种自动客户端代码生成器来创建我的客户端代码。我首先必须使用 openAPI/swagger 来记录我的 api,

回答 1 投票 0

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