swagger 相关问题

有没有办法在使用 springdoc-openapi-maven-plugin 生成的合约中拥有带有鉴别器部分的 CompositSchema？

我有一个示例 SpringBoot API，具有以下功能： 1 个控制器，公开可通过 GET 请求调用的单个端点，并返回自定义类（在我的示例中为 ContainerClass）

OpenApi - 有没有办法在使用 springdoc-openapi-maven-plugin 生成的合约中拥有带有鉴别器部分的 CompositSchema？

我有一个示例 SpringBoot API，具有以下功能： 1 个控制器，公开可通过 GET 请求调用的单个端点，并返回自定义类（在我的示例中为 ContainerClass）

当同一类型的多个端点具有不同的 Accept 标头值时，仅显示一个端点

我有一个 Spring Boot 应用程序，其休息控制器定义如下。 生成的 Swagger API 文档看起来像这样。 正如您所看到的，只有已弃用的端点显示在 UI 上...

Swagger UI - 当同一类型的多个端点具有不同的 Accept 标头值时，仅显示一个端点

我有一个 Spring Boot 应用程序，其休息控制器定义如下。 生成的 Swagger API 文档看起来像这样。 正如您所看到的，只有已弃用的端点显示在 UI 上...

更新 Docker 容器中的大文件

我目前有一组应用程序在单独的 Docker 容器中运行。容器本身在云上运行。有时，配置更新是必要的。配置你...

如何禁用 L5 Swagger 包模板中的“授权”和“尝试”按钮？

拥有这些功能对于我们的应用程序在本地和暂存中有意义，但在生产中则不然。我正在尝试找到一个地方来添加逻辑来删除这些按钮，但它看起来不像......

Docker 以 https://localhost:0/swagger 开头

我正在尝试使用 docker 运行 .Net 7 简单应用程序 来自 mcr.microsoft.com/dotnet/sdk:7.0 AS build-env 曝光 80 工作目录/src 复制 。 。 运行 dotnet 恢复 运行 dotnetpublish-cRelease-o/app/

如何从 Swagger for ASP.NET Core 中的泛型类型名称中删除引号和数字？

我正在使用 ASP.NET Core 和 ("openapi": "3.0.1") 开发一个 API 来生成文档。但是，当使用泛型类型时，Swagger 会生成带有引号和

如何在 Swashbuckle 文档中添加换行符？

我正在使用 swagger/swashbuckle 为 Web Api 2 中实现的 api 生成文档。 唯一可识别的 xml 文档标签是 、 和 .... 我正在使用 swagger/swashbuckle 为 Web Api 2 中实现的 api 生成文档。 唯一可识别的 xml 文档标签是 <summary>、<remarks> 和 <param>。 这意味着我无法使用 <para> 标签来格式化新行或段落中的文本，所有内容都在文档的实施说明条目中生成为连续的长段落。 有什么办法可以做到这一点吗？ 我发现你只需在评论中添加 <br /> 标签即可实现此目的。 添加： /// <br /> 将导致生成的文档中换行。 另一种实现方法是创建自定义操作过滤器并使用 xml 文档标签，如下所述： https://github.com/domaindrivendev/Swashbuckle/issues/258 希望这有帮助 山姆 在 SwashBuckle.AspNetCore 中 <br /> 和 &lt;br /&gt（在 github 中建议）不起作用。 在 <remarks> 中，您可以在行尾指定反斜杠。 例如 /// <remarks> /// before. \ /// after. /// </remarks> 生成2行 before. after. 但是我无法在 <summary> 部分生成多行。 注意，如果该行有尾随空格（例如"before. \ "），反斜杠将在输出中按字面显示。 您可以在https://github.com/MNF/Samples/blob/master/SwashbuckleExample/SwashbuckleExample/Controllers/SwashBuckleTest.cs中看到我的一些尝试 发布的解决方案均不适用于较新版本的 Swagger。如果您希望注释行之间有换行符分隔，则必须为换行符添加 ///。这使得方法注释变得冗长，但在 Swagger 文档中它们将更具可读性。 /// <summary> /// Comment Line 1 /// /// Comment Line 2 /// /// Comment Line 3 /// </summary> 根据 Markdown 规范，可以通过添加双空格（两个空格）来结束行来在备注中添加新行 使用Visual Studio 2019（.net core 3.1），我可以使用html注释。 使用 <br /> 可以在一行内完成所有操作。 我还尝试过其他 html 标签，例如下划线和粗体。 /// <summary> /// test /// </summary> /// <remarks><u>underline</u> "test line 1" <br /><b>Bold</b> "test line 2" </remarks> 使用下面的结构，Swashbuckle UI 和 ReDoc UI 都可以工作： /// <summary> /// Title /// /// <para>Content line 1</para> /// <para>Content line 2</para> /// <para>Content line 3/</para> /// </summary> 重要提示：不要忽略每行末尾的空格 如果所有答案都不适合您，则在某些情况下部分有效，就像我一样。 您可以使用<br></br>。不要使用</br>。有时它会破坏 XML。 Visual Studio 显示 <br/> 的 XML 格式错误 经过长时间的搜索，我发现 *** 代表粗体文本，我知道它不是同一主题，但我很确定这对这里的人有用！ 示例： ***400 - BadRequest When any parameter is out of specification.*** 我使用 Visual Studio 2022 和 openapi 版本 3.0.1 作为默认值， 要完整的文档，你可以这样做， 首先：确保您在项目中启用了 XML 文档，如下所示： 编辑您的 .csproj 文件（我的项目是 .net core 7，您也可以对 core 8 执行此操作）： <PropertyGroup> <TargetFramework>net7.0</TargetFramework> <GenerateDocumentationFile>true</GenerateDocumentationFile> <DocumentationFile>bin\Debug\net7.0\WebApi.xml</DocumentationFile> <NoWarn>$(NoWarn);1591</NoWarn> </PropertyGroup> 这将在路径 bin\Debug 处创建 WebApi.xml 文件 et7.0\ 每当您构建项目时。 注意： 如果所有方法都没有 XML 注释，NoWarn 会抑制警告。 现在您可以为自定义文档添加多行和示例，如下所示： /// <summary> /// Latest Version: 1.0.2 /// </summary> /// <remarks> /// ### Version Walkthrough: /// /// #### Version 1.0.0 (Base Version): /// /// ```json /// { /// "version": "string", // Optional, 1.0.0 is Default /// "defParam1": 0, // Mandatory /// "defParam2": "string" // Mandatory /// } /// ``` /// /// #### Version 1.0.1: /// /// ```json /// { /// "newParam1": "string", // Added in ver1.0.1 for specific feature /// "newParam2": "string" // Added in ver1.0.1 for another feature /// } /// ``` /// /// #### Version 1.0.2: /// /// ```json /// { /// "newParam3": "string" // Added in ver1.0.2 for new functionality /// } /// ``` /// /// ### Example Request: /// /// ```json /// { /// "version": "1.0.2", /// "defParam1": 123, /// "defParam2": "sample data", /// "newParam3": "new data" /// } /// ``` /// </remarks> /// <response code="201">Returns the newly created item</response> /// <response code="400">If the item is null</response> /// <response code="401">Authorization is failed</response> [HttpPost] public ProcedureVersioningViewModel GetAllProcedureVersion(GetProcedureVerionResponseItemViewModel model) { return _procedureVersionService.GetAllProcedureVersion(model); } 输出是这样的（我如何向 swagger 添加一些 CSS 和样式以使其 UI 更漂亮）：

Swagger/OpenApi 似乎不理解我的 LocalTime 类型的 DTO 字段，为请求正文创建 JSON 而不是字符串

Swagger/OpenAPI v3 不尊重 Spring Boot DTO 中的 LocalTime 数据类型的问题 环境： 春季启动：3.3.2 Java：17（亚马逊 Corretto） PostgreSQL：15.3 Swagger/OpenAPI：Springdoc OpenAPI v...

在 Swashbuckle.Core 中使用 IIS 虚拟目录作为所有端点的前缀

我目前正在尝试让我的端点在 Swagger 上为其基本路径（/my-application/）添加前缀。 我正在使用 Swashbuckle 和 Swashbuckle.Core v5.6.0 运行 .NET 4.7.2 应用程序。 /我的应用程序/...

带有路由参数、标头且无正文的 FastEndpoints PATCH

如何使用 drf-yasg 自动生成的 swagger 页面配置“HTTPS”方案？

我知道在传统的 swagger YAML 文件中，我们可以使用以下方式定义方案： 方案： - http - https //或者 方案：[http、https] 但是，我怎样才能用自动生成的 swagger 做同样的事情......

Azure 函数、Swagger、OpenApi

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

使用 Spring Boot 配置 Swagger UI

我正在尝试使用我的 Spring boot 应用程序配置 Swagger UI。虽然 v2/api-docs 似乎加载正确，但 http://localhost:8080/swagger-ui.html 没有加载我带注释的 REST...

Springboot springdoc-openapi 如何自定义swagger

添加下面的依赖项可以访问 swagger ui。 org.springdoc springdoc-openapi-starter-webmvc-ui 添加下面的依赖项可以访问 swagger ui。 <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.6.0</version> </dependency> 但是如何使用此依赖项编辑 Swagger 标题等。在 springfox 中，可以使用 docket bean。 springdocs 里怎么可能？ 尝试编辑Springdocs的swagger。 有两个可以自定义您的 openapi 模板。 一般有两种方式： 1-通过java代码并创建bean配置： 第一种方法，是通过java代码配置它，在其中实现一个bean，并编写有关它的文档，它看起来像这样，但我不推荐它： @Configuration public class OpenApiConfig { @Bean public OpenAPI customOpenAPI() { return new OpenAPI() .info(new Info() .title("Custom API Title") .description("Custom API Description") .version("1.0.0") .contact(new Contact() .name("API Support") .url("http://example.com/contact") .email("[email protected]")) .license(new License() .name("Apache 2.0") .url("http://springdoc.org"))) .externalDocs(new ExternalDocumentation() .description("Full Documentation") .url("http://example.com/docs")); } } 2- yaml/属性配置 第二种方法是使用 springdoc-openapi 创建模板并创建 yml 或 properties 文件，其中包含有关 openapi 的文档，然后当您的应用程序运行时，您可以看到文档。 它看起来像这样： springdoc: api-docs: path: /v3/api-docs swagger-ui: path: /swagger-ui.html info: title: Custom API Title description: Custom API Description version: 1.0.0 contact: name: API Support url: http://example.com/contact email: [email protected] license: name: Apache 2.0 url: http://springdoc.org external-docs: description: Full Documentation url: http://example.com/docs

无法在本地从新 API 加载 Swagger 页面

我正在使用 Visual Studio 2022，我有一个新的 ASP.NET Core 8.0 Web API 项目。我删除了创建项目时加载的示例天气预报的所有痕迹，但现在当我调试我的

在C#中从动态Json对象动态生成OpenApiSchema

我希望从 .Net 6 中的任何给定 Json 对象动态生成 OpenApiSchema。我在代码中没有可用的 clr 类型来自动生成 Swashbuckle 使用的 Open API Json，并且需要...

springboot 3.2.10 和 springdoc-openapi 2.2.0 没有静态资源 swagger-ui/index.html

升级到 spring boot 3.2.10 和 springdoc-openapi-starter-webflux-ui 2.2.0 后，无法加载 swagger UI 并出现以下错误： org.springframework.web.servlet.resource.

创建 URL 中定义的名为“webMvcRequestHandlerProvider”的 bean 时出错

我正在尝试使用 springdoc-openapi-starter-webmvc-ui 将 Swagger 集成到 springboot 项目中。 我的依赖项是 org.springdoc <