openapi 相关问题

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

是否有任何API或数据集可以提供世界上所有旅行地点的城市、州、国家、纬度和经度

我正在学习使用 Python Pandas 进行数据提取和数据操作,并且需要使用 Matplotlib 进行一些可视化。

回答 1 投票 0

OpenApi 中的摘要和描述有什么区别?

我注意到在 OpenAPI 路径项和其他一些构造中都有摘要字段和描述字段,它们之间有什么区别,每个字段的用途是什么?对我来说,他们似乎...

回答 2 投票 0

从 API 平台 Swagger/OpenAPI 文档输出中删除一些模式/模型

API-Platform 将生成 Swagger/OpenAPI 路由文档,然后生成下面的架构文档(又名模型)(文档将它们显示为“模型”,但当前版本如 2.7 s...

回答 2 投票 0

Redoc 无法生成 html 模板(出现问题...无法获取)

我正在尝试将 Redoc 集成为 swagger 的替代方案,以便使用 springboot 2.7 (java 11) 获得更好的个性化文档在搜索错误原因后,我找到了几个答案...

回答 1 投票 0

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

我有一个 Django 项目,我正在使用 Django REST 框架。我正在使用 drf-壮观 对于 OpenAPI 表示,但我认为我的问题与这个包无关,它似乎是一个更通用的 Op...

回答 3 投票 0

使用 Spring Boot 3.2.2 配置 springdoc-openapi 时遇到问题

我正在开发一个具有 Rest API 的 Spring Boot 项目。这是一个后端项目。 我正在按照此处的文档配置 OpenAP I3.0 https://springdoc.org/#Introduction 我已经包括了这个

回答 1 投票 0

openapi-generator-cli,c#自定义为oneOf requestBodies生成的属性和类型名称以及多态属性

我有一个API,其中包含一些具有多态属性的复杂DTO,以及一些接受多态请求体(oneOf)的点。 像下面这样: C# 复杂类型示例 命名空间

回答 1 投票 0

路径参数未从 UI 填充

我正在使用 Swashbuckle.AspNetCore 6.5.0 视图类型=完整 widgetguid=940FFD66-A7C2-42F5-AAA2-153CBF9136EE 在 Swagger UI 中,当我执行填充了两个路径参数的 API 调用时,它会生成以下内容: 哈...

回答 1 投票 0

为什么 SpringDoc OpenAPI 不理解 MultipartFile 负载?

我正在开发一个 Spring boot 应用程序,它有一个控制器来帮助上传多部分文件: @PostMapping(“/文件”) 公共 ResponseEntity uploadFiles( @RequestParam(&q...

回答 3 投票 0

OpenAPI:使用Gradle生成时必须指定生成器名称错误

我面临 OpenAPI 的特殊问题 本质上,我正在尝试使用 OpenAPI 为其余 api/服务器生成一些代码 这就是我到目前为止所拥有的 构建脚本{ 存储库{

回答 1 投票 0

来自 proto openapiv2 规范的响应示例

假设我有一个如下的rpc方法 rpc RpcMethod(RpcRequest)返回(RpcResponse){ 选项 (google.api.http) = { 获取:“/rpcMethod” 身体: ”*” }; 选项(grpc。

回答 1 投票 0

从 OpenAPI 3.1 yaml api 定义生成 JSONSchema

我正在用Java和SpringBoot(Angular和Typescript)实现一个Web应用程序 我们决定采用“API 优先”的方法,并以 openAPI 3.1 格式设计 API。 这些 yaml fi...

回答 1 投票 0

调用openapi生成的API时出现GenericSignatureFormatError

问题 我有 openapi (7.0.0) 生成的控制器和模型在 Spring WebFlux 服务器 (5.x) 上运行。一切都在本地运行,但是当部署到 kubernetes pod 时,任何 PUT 请求都会失败(请参阅 st...

回答 1 投票 0

OpenApi 3.0 处理刷新令牌 n 下载 Excel 端点

我有一个使用 OpenApi 3.0.3 的 Java 应用程序。 我已经实现了一个生成 excel 的端点,在 yaml 中定义如下: /api/secured/customers/export: 邮政: 摘要:出口客户...

回答 1 投票 0

在路由中使用枚举

使用控制器时,您可以在路由中使用枚举,但必须添加以下内容 builder.Services.AddControllers(); .AddJsonOptions(选项=> options.JsonSerializerOptions.Conve...

回答 1 投票 0

是否有任何工具可以从 JSON 或 Open API 自动创建类似 wiki 的 REST API 文档?

我有多项服务,每一项服务都通过 REST API 和 ASP.NET Core Web API 公开。我使用 Swashbuckle 作为 ASP.NET Core 工具,以便从我的控制器和 DTO 自动生成所有...

回答 2 投票 0

Open api 生成器不会生成可重用枚举的枚举

有一个开放的api yaml: 父计划状态: 类型:字符串 枚举: - NOT_PLANNABLE - 可规划 - REQUEST_EXTRA_DAY - REQUEST_EXTRA_DAY_DURING_HOLIDAY 用于其他对象,例如:

回答 1 投票 0

如何使用 drf-spectaulous 为 Django Rest Framework 自定义响应 api 架构 [已解决]

我在自定义 API 模式时遇到问题。 这是我的案例: 我需要在序列化器中返回一个实例列表及其字段,但也应该有一个常见的聚合字段,t...

回答 1 投票 0

步骤 CI 工作流程运行时错误,路径中带有斜线

我的问题是当我运行测试(stepci run fakedata.yaml)时出现错误(在图像中): 我尝试检查某些网站的验证,我的 YAML 文件没有问题。我尝试过...

回答 1 投票 0

使用 Spring Boot 3 的开放 API 时出现 NoClassDefFoundError

我升级到 Spring boot 3.0.7 并尝试让我的 Open API (swagger) 再次工作,具有这些依赖项(根据 springdoc): org.springdoc 我升级到 Spring boot 3.0.7,并尝试让我的 Open API (swagger) 再次工作,并使用这些依赖项(根据 springdoc): <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.7.0</version> </dependency> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency> ...但是当我构建我的应用程序时,出现以下错误: java.lang.IllegalStateException: Failed to introspect Class [org.springdoc.webmvc.api.OpenApiWebMvcResource] from ClassLoader [jdk.internal.loader.ClassLoaders$AppClassLoader@1de0aca6] ...“原因”为: java.lang.NoClassDefFoundError: javax/servlet/http/HttpServletRequest 当我查看 OpenApiWebMvcResource jar 中的 org.springdoc:springdoc-openapi-webmvc-core:1.7.0 时,它确实是从 javax 而不是 jakarta 导入的: package org.springdoc.webmvc.api; import com.fasterxml.jackson.core.JsonProcessingException; import io.swagger.v3.oas.annotations.Operation; import java.util.Locale; import java.util.Optional; import javax.servlet.http.HttpServletRequest; ... 那么这是openapi-webmvc-core的问题吗,还是我接线有问题? 升级后也有同样的问题。 您只需要添加一个依赖项 springdoc-openapi-starter-webmvc-api 并且不需要额外的配置。删除依赖 springdoc-openapi-ui <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency> 您不需要指定packagesToscan[]或不需要使用withClassAnnotation(RestController.class)),它会在寻找@RestController Annotation并生成文档时自行处理。 https://springdoc.org/v2/#spring-webmvc-support 在我的例子中(Spring Boot 3.0.5 和 Java 17)除了添加以下内容 <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency> 我还必须添加这个依赖项 <dependency> <groupId>javax.xml.bind</groupId> <artifactId>jaxb-api</artifactId> <version>2.3.1</version> </dependency> 然后效果很好。 根据 Spring Doc /v2 指南,我只需要引入 springdoc-openapi-starter-webmvc-ui 依赖项,而不是 springdoc-openapi-ui。所以当我的 pom.xml 看起来像: <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency> ...那个错误消失了,并且成功了。 请注意,无论出于何种原因,我还需要引入这些依赖项,否则我会得到一个 java.lang.NoClassDefFoundError: jakarta/xml/bind/annotation/XmlRootElement: <dependency> <groupId>jakarta.xml.bind</groupId> <artifactId>jakarta.xml.bind-api</artifactId> <version>${jakarta.xml.bind.version}</version> </dependency> <dependency> <groupId>org.glassfish.jaxb</groupId> <artifactId>jaxb-runtime</artifactId> <version>${org.glassfish.jaxb.version}</version> </dependency> 我在从 springboot2 迁移到 springboot 3 时也遇到了类似的问题,我按照建议添加了 springdoc-openapi-starter-webmvc-ui 然后我遇到了上述问题,在调查依赖树时我发现 springdoc-openapi-ui:1.7.0 位于通过 Maven 传递依赖功能的路径中。 因此,只需排除以下依赖项,然后一切都会顺利进行。 我遇到了同样的问题:我已经从 springboot2 迁移到 springboot 3,我按照建议添加了 springdoc-openapi-starter-webmvc-ui 然后我遇到了上述问题。如果我导航 Maven 库,我可以看到 springdoc-openapi-starter-webmvc-api 仍然引用 springdoc-openapi-ui:1.7.0。我怎样才能排除这种依赖性? 如果我像这样在 dependencyManagement 中排除此依赖项: <dependencyManagement> <dependencies> <!-- Swagger --> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>${org.springdoc}</version> <exclusions> <exclusion> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> </exclusion> </exclusions> </dependency> </dependencies> </dependencyManagement> 错误不再显示,但是当我导航 http://localhost:9099/swagger-ui/index.html 以测试 Swagger UI 时,会显示 Whitelabel 错误页面。 请发送帮助:)

回答 5 投票 0

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