Swagger是一个框架实现，用于基于Open API规范描述，生成，使用和可视化RESTful Web服务
我从一些 JSON 文件创建了一个 API 规范，我正在尝试测试这些文件是否根据 API 规范进行验证。 有一些很好的工具可以根据 JSON Schema 进行验证，但我没有机会......
我想在 Swagger 中有登录功能。我能够显示登录按钮，但它不起作用。首先，它要求提供客户端 ID 和客户端秘密，但我没有秘密
如何在 Swagger 模型中定义具有任意键的映射 假设我有以下国际化模型（在 Ruby 风格的伪代码中，假设使用 Globalize 之类的东西） 类东西
我正在使用 wsdltophp 使用外部 wsdl。这为我生成了一个大型类结构，我希望通过 SwaggerUI 通过我的 API 来使用它。 这就是我注释 API 条目的方式...
如何在OpenAPI描述中定义一个可以是电子邮件格式或空字符串的属性（swagger）
我有一个电子邮件字段，用户将其作为 POST/PUT API 的一部分发送。我想使用 OpenAPI 规范验证电子邮件是否采用正确的电子邮件格式（如果存在）。如果它是空的...
我正在尝试在 gitlab 中显示我的 Swagger API 文档。 但是，我不想显示源代码，而是显示渲染的文件。 我在另一个小组看到这是可能的： 在这个今...
有没有办法在使用 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 上...
如何禁用 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 会生成带有引号和
我正在使用 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 /> 和 <br />（在 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 应用程序。 /我的应用程序/...
如何使用 drf-yasg 自动生成的 swagger 页面配置“HTTPS”方案？
我知道在传统的 swagger YAML 文件中，我们可以使用以下方式定义方案： 方案： - http - https //或者 方案：[http、https] 但是，我怎样才能用自动生成的 swagger 做同样的事情......
就像我正在玩的标题一样：Azure Function、Swagger 和 OpenApi。 看下面的代码： [函数（“v1/job/selectAll/{agentId}”）] [OpenApiOperation(操作Id: "selectAllJ...