openapi 相关问题

使用 APICTL 将 API 从 WSO2 APIM v3.2 导入到 v4.3 时如何解决“内部服务器错误 500”？

我正在尝试从 WSO2 API Manager v3.2 导出 API，并使用 APICTL 2 版本 v3.2 和 v4.3 工具将其导入 WSO2 API Manager v4.3。使用 APICTL v3.2 的 v3.2 导出过程有效...

如何配置 OpenAPI yaml 文件的最大文件大小？

我们的 Quarkus 生成的 OpenAPI 文档很大。 当我尝试使用 Swagger UI 查看时，出现以下错误： ' 导致：com.fasterxml.jackson.dataformat.yaml.JacksonYAMLParseException：传入的 YAML

使用 api 平台为 Symfony 自定义控制器生成 OpenAPI

我刚刚开始使用 Symfony (7.1) 并创建了一个控制器。 现在我想为控制器端点生成 OpenAPI 描述，我已经找到了 api_platform (4.0)。 （https://api-

Java 中的 REST API - 如何使用 Hibernate Validator 支持 PATCH

在 Java 中编写 REST-API 时，PATCH 方法请求将请求实体中描述的“一组更改”应用于由 Request-URI 标识的资源。 （参见：https://

使用 NSwag 为 OpenAPI v3 中的泛型类型生成有效架构

我正在尝试使用 NSwag 生成有效的 OpenApiDocument，但在以应有的方式生成模式时失败。我目前正在全局为我的类型添加架构，如下所示： 变量类型...

在 OpenAPI 响应架构中使用 oneOf

堆栈 固定 数据 使用 addSchema 方法添加的几个模式： 服务器.addSchema({ $id: '事件', 类型：'对象'， 特性： { 事件 ID：{ $ref: 'id' ...

Azure 函数、Swagger、OpenApi

就像我正在玩的标题一样：Azure Function、Swagger 和 OpenApi。 看下面的代码： [函数（“v1/job/selectAll/{agentId}”）] [OpenApiOperation(操作Id: "selectAllJ...

Spring Boot：OpenApi 生成器插件创建不需要的测试文件

我使用 OpenApi 3.0 和 maven 插件 openapi-generator-maven-plugin 来生成我的 api + 对象。 这是我的 Maven 配置： ...

OpenAPI 两次生成AdditionalProperties 字段

我正在通过 OpenAPI 生成 Swagger 客户端，但由于它被定义了两次而出现额外属性错误。 json 架构是从 FastEndpoints 项目生成的，我尝试添加架构

NestJS Swagger 与 Zod 的多部分文件上传问题

我正在开发一个 NestJS 应用程序，并使用 Nestjs-zod 库进行验证和 swagger 文档。但是，在尝试以多部分表单数据请求上传文件时，我遇到了问题...

Springboot 2.X 与 openapi-generator 7.2 的兼容性

目前，我们在一个使用 Spring boot 2.5 的项目中，我想将我的 openapi-generator 从 5.3 升级到 7.2，我在 mvn 依赖项中搜索以查找此版本的

验证的开放 API 规范无法上传到 Azure API 管理

我正在尝试在我的 azure api 管理服务上导入与 https://github.com/ccouzens/keycloak-openapi/blob/master/keycloak/9.0.json 类似的 OpenAPI 规范 json。 我验证了我的版本...

Azure API 管理导入 openapi 生成长名称

我通过java注释生成了以下openapi.json，当我将其导入azure api管理门户时，它会生成一个长名称，例如：

向最终用户显示 FastAPI 验证错误

我正在寻找一些库或代码示例，将 FastAPI 验证消息格式化为人类可读的格式。例如。这个端点： @app.get("/") 异步 def hello(名称: str): 返回{“你好”：...

如何通过nswag正确返回json输出

我正在使用 nswag 通过 yaml 文件生成服务器端 C# 控制器代码。 我可以通过 API 调用者（例如邮递员）成功调用端点。 主要问题是输出不是...

将OpenAPI的AdditionalProperties默认设置为false

我的 OpenAPI 规范包含很多对象。根据规范，自由形式对象默认具有additionProperties:true。这就是为什么当我使用 NSwag 生成 C# 客户端时，所有

Swagger使用AllOf时无法生成文档

我正在使用 ASP.NET Core 8 Web API 和 Swagger。 当我尝试使用 UseAllOfForInheritance 生成带有 allOf 的代码时，使用以下代码构建 swagger： 生成器.Services.AddSwaggerGen( ...

使用 OpenAPI 时禁用 API 身份验证

我正在使用下面的 spring 和 openAPI 依赖项： org.springframework.boot spring-boot-starter-parent 我正在使用下面的 spring 和 openAPI 依赖项： <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>3.3.2</version> </parent> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.6.0</version> </dependency> 我的安全配置类定义如下： @Bean public UserDetailsService userDetailsService() { // ensure the passwords are encoded properly UserDetails userDetails = new User(userName, password, Collections.singleton(new SimpleGrantedAuthority("ROLE_" + ROLE))); return new InMemoryUserDetailsManager(userDetails); } @Bean @Primary @ConditionalOnProperty(value = "swagger.auth.enabled", havingValue = "true", matchIfMissing = true) public static BCryptPasswordEncoder passwordEncoder() { return new BCryptPasswordEncoder(); } @Bean public SecurityFilterChain filterChain(HttpSecurity http) throws Exception { String regexPattern; if(swaggerAuthEnabled) { /* Desc: Below regex will hold true for : * - pattern containing health in its resource * - pattern if it not contains * > /actuator/<something> * > /v2/api-docs * > /swagger-ui.html * */ regexPattern = ".*(/health)|^(?!/v2/api-docs|.*/swagger\\-ui\\.html|.*/actuator/).*$"; } else { regexPattern = ".*"; } return http.authorizeHttpRequests(authorize -> authorize.requestMatchers(regexPattern) .permitAll().anyRequest().authenticated()) .httpBasic(Customizer.withDefaults()).build(); } 我添加了类型为：HTTP的SecurityScheme和方案：BASIC 我的目标是通过 swagger UI 添加身份验证，工作正常，但我的所有 API 现在也都落后于身份验证，因此我在通过邮递员或其他服务访问它们时收到 401 错误。 我对 OpenAPI 还很陌生，似乎在浏览有关堆栈溢出的所有其他相关解决方案时迷失了方向。 感谢您的帮助！ 如果我正确理解你的问题，问题是现在每个请求都必须经过身份验证.anyRequest().authenticated()，如果你只想允许任何未经身份验证的请求发送到任何端点，你必须将其更改为.anyRequest().permitAll()

如何从 Swagger UI 中的“架构”部分隐藏某些架构（OpenAPI 3、Spring Boot）

我正在使用 Springdoc 来记录我在 Spring Boot 中制作的 REST API。 我需要从 Swagger UI 的 Schemas 部分隐藏一些模型/模式，这些模型/模式仅在 API 内部使用，所以不需要

当响应太大约 2mb 时，Swagger UI 会冻结

我已使用 Microsoft.Azure.Functions.Worker.Extensions.OpenApi 将 OpenAPI 文档添加到我的 Function 应用程序项目中，但是当响应太大（大约 2mb）时，swagger/ui 会冻结。有没有什么...