swagger-ui 相关问题

如何为CommunityToolkit的Datasync框架制作SwaggerUI文档POST参数

我想构建一个由以下部分组成的解决方案： 应用程序编程接口 离线启用的 Avalonia 客户端 管理网站 我设置了 CommunityToolkit.Datasync.Server 的测试实现并检查了 Swa...

如何从java中的swagger文档中隐藏枚举值

使用java和springdoc-openapi，我目前正在使用这样的枚举： 枚举阶段 { 阶段1、阶段2、阶段3、阶段4等……； } 对于一个控制器，我想...

Swagger Jersey：如何指定布尔值作为响应模型

我的 Jersey RestFull 服务之一返回一个布尔值，但是我无法在 Swagger 注释中指定该值。 @ApiResponses(值={ @ApiResponse(code = 200, message = "布尔值 true on

FastAPI 的 RedirectResponse 在 Swagger UI 中无法按预期工作

我有一个带下载端点的 FastAPI 应用程序。此下载端点的作用是使用 BlobServiceClient（对于 Azure Blob 存储）生成令牌和指向

根据 Swagger API 模式验证 JSON

我从一些 JSON 文件创建了一个 API 规范，我正在尝试测试这些文件是否根据 API 规范进行验证。 有一些很好的工具可以根据 JSON Schema 进行验证，但我没有机会......

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

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

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

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

如何禁用 L5 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 更漂亮）：

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

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

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

在.Net Core 6 Web API中为swagger添加复制按钮

我使用 .net core 6 构建了一个 REST API 并向其中添加了 swagger UI。 当我运行 API 时，将鼠标悬停在路线上时看不到“复制到剪贴板”按钮。 我该如何添加它？ 这些是我安装的...

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

未捕获的引用错误：SwaggerUIBundle 未在 window.onload 中定义

在我的本地主机中，我的 swagger UI 运行良好。本地主机:3030/文档 这个 UI 在服务器上也可以工作，但从今天开始在服务器上它不再工作 https://digitalpathshalabd.com/

在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 <

如何保护.NET 8中的swagger/1.0/swagger.json路由？

我在 ReactJS 应用程序中创建了一个自定义 SwaggerUI (index.html) 文件，可以通过 myapplication.com/docs/swagger/index.html 访问该文件。由于路由经过 /docs/，所以 STS 认证是 ap...

如何从 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 会冻结。有没有什么...