swagger 相关问题

OpenAPI/Swagger：响应中的数组

我想返回路径中的活动列表。我尝试通过在 items 属性中定义 Activity 类型来实现这一点： #... # 这里的意图不正确 回应： “200”： 描述...

在编译/构建时从 Spring 代码生成 OpenAPI V3 规范

我有一个 Spring boot 应用程序。我正在尝试从 Swagger 2 切换到 OpenAPI v3。 早些时候我依赖 https://github.com/kongchen/swagger-maven-plugin ，它非常棒并且用于支持......

如何基于 Swagger 的自定义注释创建注释/描述

我有一个 Springboot Rest 应用程序，其中有自动转换 API 和参数的注释。 我有自定义注释，其中包含一些注释，我怎样才能获得该生成...

为什么我的Swagger index.html页面发布后是空白的？

我正在编写 ASP.NET Core Web API。我的环境是 ASP.NET Core 5.0，开发中使用 Windows 10 和 Visual Studio 19，生产中使用 Windows Server 2016 和 IIS。我正在使用 C# 进行开发，并且

如何禁用 springdoc openapi 和 swagger 的默认响应

我对 springdoc-openapi 和 swagger 有问题。在 api.yml 文件中，我定义了一些端点响应，例如： 回应： 200： 描述：响应示例 内容： ......

WebAPI 和 OData8 与 Swagger 中的控制器名称冲突

我有一个问题，从我围绕控制器名称冲突和招摇问题的研究来看，这个问题似乎很常见。 如果我在控制器一中有两个 Get() 函数 和

如何在SpringBoot 3.2.0中运行Swagger？

当我使用** springboot 3.2.0 和 swagger 2.9.2 时，它不起作用**。我如何在不降级 springboot 3.2.0 版本的情况下修复它？ 这是我的招摇配置 包 com.lifepill.possystem.config；

WebAPI 和 OData8 与 Swagger 中的控制器名称冲突

所以我有一个问题，从我围绕控制器名称冲突和招摇问题的研究来看，这个问题似乎很常见。 如果我在控制器一中有两个 Get() 函数 和两个 Get() 函数...

如何使用 Typescript 和 Node 生成 REST API 文档？

我可以使用 https://github.com/TypeStrong/typedoc 创建 REST API 文档，如 https://apidocjs.com/ 吗？ 欢迎任何有关如何重用 TypeScript 类型来生成 REST API 文档的建议（使用 Nex...

Swagger 文档中没有显示 XML 注释，这是 swagger 中的错误吗？

Swagger xml 注释没有显示在文档 UI 中，不确定我在这里遗漏了一些东西..至少有人告诉我这是一个错误 第 1 步：创建一个全新的 ASP.NET Web 应用程序我们...

如何在 swagger 中提供包含数组作为其属性之一的对象定义示例

参考下面的例子，我想在它的定义中提供一个NamedElementArray的例子。这将需要显示元素属性的 NamedElement 数组的示例...

Swagger UI Oauth2 回调发送代码作为查询参数而不是发布

我正在尝试使用 OIDC 来保护 .NET 8 API。我的项目基于这篇文章：https://auth0.com/blog/backend-for-frontend-pattern-with-auth0-and-dotnet 至此我就可以调用登录了

为什么 swagger 文档在 PythonAnywhere 域上不起作用？

我使用 swagger 在 Django Rest 框架上记录我的 API，并将其部署在 Pythonanywhere 上。 但文档 URL 没有任何响应。 这是我的 urls.py swagger 代码： 来自

为什么 Swashbuckle/Swagger 在参数中包含变量名称？

对于较旧的网络框架项目，我使用的是 Swashbuckle 5.6.0。当我使用类作为 get 参数时，会发生奇怪的事情。它将变量名称添加到参数中。 这意味着消费...

如何在 Swagger UI 中禁用缓存

我正在使用 swagger UI 来记录 API。我已经使用 docker 部署了 Ui 和节点服务器（具有 JSON）。部署后，当我在 JSON 文件中进行更改时，同样没有得到反射...

使用 GRPC 服务时，Swagger 未在 ASP.NET Core WebAPI 应用程序中加载

我目前正在开发一个项目，其中有一个共享 GRPC 库，其中包含客户端和服务器的原型文件。然后，该库将包含在主 ASP.NET Core WebAPI 项目中。 ...

Swagger UI 不显示 ASP.NET Core Web API 中文件输入的上传按钮

我正在开发一个 ASP.NET Core Web API 项目，特别是使用 Microsoft 提供的 ASP.NET Core Web API 模板。我遇到了 Swagger UI 不显示上传 b 的问题...

ZOD 到 swagger API Dto 类用于 Nestjs swagger

如何将这个 zod 模式转换为 swagger 用户的 CountryDto ？我使用 Nestjs 和 zod 进行输入验证。使用 nesjs/swagger 包进行 swagger。 导出 const CountrySchema = z .

API Gateway 不聚合微服务 swagger 文档 Spring boot

Pom.xml： io.springfox springfox-boot-starter 3.0.0 Pom.xml： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.6.7</version> </dependency> SwaggerConfig.java： @Configuration @RequiredArgsConstructor public class SwaggerConfig { private final RouteDefinitionLocator locator; @Bean public List<GroupedOpenApi> apis() { List<GroupedOpenApi> groups = new ArrayList<>(); List<RouteDefinition> definitions = locator.getRouteDefinitions().collectList().block(); definitions.stream().filter(routeDefinition -> routeDefinition.getId().matches(".*-service")).forEach(routeDefinition -> { String name = routeDefinition.getId().replaceAll("-service", ""); GroupedOpenApi api = GroupedOpenApi.builder().pathsToMatch("/" + name + "/**").group(name).build(); groups.add(api); }); return groups; } } application.yml： gateway: discovery: locator: enabled: true lower-case-service-id: true routes: - id: swagger uri: http://localhost:${server.port} predicates: - Path=/v3/api-docs/** filters: - RewritePath=/v3/api-docs/(?<path>.*), /$\{path}/v3/api-docs - id: test-service uri: lb://test-service predicates: - Path=/testservice/** filters: - RewritePath=/testservice/(?<path>.*), /$\{path} Api 网关在发现服务器的帮助下看到测试服务。当我进入网关服务器的 swagger-ui 时， 在“选择定义”选项卡中，我只看到“默认”定义，但没有看到我真正想要的测试服务定义。我使用过这些教程： https://piotrminkowski.com/2020/02/20/microservices-api-documentation-with-springdoc-openapi/ https://dgempiuc.medium.com/api-gateway-swagger-composition-e9416398ca47 我用这个解决了application.yml： spring: cloud: gateway: routes: - id: openapi uri: http://localhost:${server.port} predicates: - Path=/v3/api-docs/** filters: - RewritePath=/v3/api-docs/(?<path>.*), /$\{path}/v3/api-docs - id: characters-service uri: lb://characters-service predicates: - Path=/characters-service/** filters: - RewritePath=/characters-service/(?<path>.*), /$\{path} springdoc: enable-native-support: true api-docs: groups: enabled: true enabled: true group-configs: - group: api-gateway packages-to-scan: - dev.kambei.apigateway display-name: API Gateway - group: characters-service paths-to-match: - /characters-service/** display-name: Characters Service swagger-ui: config-url: /v3/api-docs/swagger-config url: /v3/api-docs urls: - url: /v3/api-docs name: API Gateway - url: /characters-service/v3/api-docs name: Characters Service 您可以在yaml文件中添加此配置： springdoc: api-docs: enabled: true swagger-ui: config-url: v3/api-docs/swagger-config url: /v3/api-docs urls: - name: test url: /v3/api-docs/test

我无法使用 Spring Security 访问 swagger url

我在我的项目中使用 Spring Security，现在我尝试使用 Swagger OpenAPI 创建文档，但我一直遭受由此引起的冲突。我不知道我要做什么...