swagger 相关问题

如何在 Java-Spring 服务器应用程序中使用 Swagger 生成以 StreamingResponseBody 作为返回类型的端点？

我想使用开放 API - Swagger 编写一个作为响应 ***StreamingResponseBody *** 返回的 POST 端点定义。由于要下载的数据非常庞大，我发现反而......

如何在 Create 方法上设置 Swagger 忽略 id 属性？ C# ASP.NET Core Swagger

如何让 Swagger 不询问 POST 方法（在数据库中创建实体）的 id？ { “id”：0， “名称”：“字符串”， “数量”：0， “类型ID”：0， ...

如何忽略 Swagger 正文输入上的属性但仍显示在响应中？

我正在使用 Swashbuckle 和 Swagger UI 自动生成 API 文档。 我的人员端点使用以下 PersonViewmodel： 公共整数？身份证{获取;放; } 公共字符串名称{获取;设置；...

从 Swagger UI 隐藏复杂的只读属性

我在 .NET 5 mvc/api 项目中使用 Swashbuckle.AspNetCore 6.1.4 OpenAPI 库。 我有一个带有过滤器模型的端点，Swagger 使用它来创建查询参数文档。 问题是

swagger .net core API 操作错误的 HTTP 方法不明确

使用 .net Core 2 API 实现 Swashbuckle/Swagger 我现在在访问 swagger.json 时收到 500 错误： NotSupportedException：不明确的 HTTP 操作方法 - EBisAPI.控制器。

ASP.NET Core 6.0 Web API 的 Swagger 实现 [已关闭]

我创建了一个仅包含一个 API 控制器的 ASP.NET Core 6.0 Web API 项目。当我们直接在浏览器中访问 url 时它可以工作，但 Swagger 不工作。请让我知道我该如何...

如何在 Swagger 中显示 IFormFile 的描述

不幸的是，在使用 IFormFile 时我无法向 Swagger 添加任何描述： [路线（“服务”）] 公共类 WebServiceController ：控制器 { /// /// 上传 ... 不幸的是，使用 IFormFile 时我无法向 Swagger 添加任何描述： [Route("service")] public class WebServiceController : Controller { /// <summary> /// An upload /// </summary> /// <param name="file">The file to be uploaded</param> /// <response code="200">File uploaded</response> [HttpPost("upload")] public IActionResult Upload(IFormFile file) { ... } } 在 Startup.cs 中我还添加了 swagger 的 xml 注释： ... services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = $"WebService API V1 ({GetType().Assembly.GetName().Version})", Version = "v1" }); // Set the comments path for the Swagger JSON and UI. var xmlFile = $"{typeof(Startup).Assembly.GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(xmlPath); }); 不幸的是，该描述未显示在 UI 中或可以在 swagger.json 中找到。有谁知道如何使用描述吗？ 我正在通过操作过滤器通过 swagger 进行文件上传； 创建一个名为 SwaggerFileOperationFilter; 的类 public class SwaggerFileOperationFilter : IOperationFilter { public void Apply(OpenApiOperation operation, OperationFilterContext context) { var fileUploadMime = "multipart/form-data"; if (operation.RequestBody == null || !operation.RequestBody.Content.Any(x => x.Key.Equals(fileUploadMime, StringComparison.InvariantCultureIgnoreCase))) return; var fileParams = context.MethodInfo.GetParameters().Where(p => p.ParameterType == typeof(IFormFile)); operation.RequestBody.Content[fileUploadMime].Schema.Properties = fileParams.ToDictionary(k => k.Name, v => new OpenApiSchema() { Type = "string", Format = "binary", Description = "some description to be show" // --> this line }); } } 重要的描述行是； Description = "some description to be show" 在 Startup.cs 中，您还应该添加以下行： ... services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = $"WebService API V1 ({GetType().Assembly.GetName().Version})", Version = "v1" }); // Set the comments path for the Swagger JSON and UI. var xmlFile = $"{typeof(Startup).Assembly.GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(xmlPath); c.OperationFilter<SwaggerFileOperationFilter>(); // --> this line }); 这是结果； 希望有帮助！

有没有办法只使用 Swagger 进行验证而不使用整个框架？

假设我有一个实现 JSON HTTP API 的现有 Java 服务，并且我想添加 Swagger 模式并自动验证请求和响应，而无需重新调整服务...

Hybris swagger UI 日期时间示例格式

我有一个 Hybris 项目，我们通过 swagger + swagger-ui 提供一个宁静的 API。我们遇到日期时间属性和参数的格式问题。它以这种格式显示：“

OpenAPI 能否以有用的方式集成 HATEOAS？

是否可以使用 OpenAPI 描述 HATEOAS REST API？ 当我以 HAL 格式描述 API 时，我需要为其定义三种模式（一种用于请求有效负载，一种用于收集资源......

在 SpringDoc 中自定义生成的模式名称

我知道 SpringDoc 现在提供了 use-fqn 选项。但是，这会添加带有点和 $ 字符的完整路径。我正在使用 api-docs JSON 生成 http 客户端，包括所有类型....

Swagger 无法解析引用：无法从 json 获取

Swagger 编辑器抛出错误，在搜索类似问题、阅读文档、谷歌搜索后......我无法得到正确的结果，你能帮我吗？谢谢 路径中的解析器错误。/create.post.parame...

Swagger 在使用 IEndpointRouteBuilder.MapGet 和 Results.Ok 时显示输出类型

我正在使用.NET 8.0。 如果我有这样的端点： IEndpointRouteBuilder 应用程序 = //... app.MapGet("用户/foo", () => { 返回新的 UserBalance() { /* ... */ }; }) .WithName("G...

Spring Boot 中 Swagger 集成错误：java.lang.TypeNotPresentException：类型 javax.servlet.http.HttpServletRequest 不存在

我正在尝试在 Spring Boot 应用程序中使用 Swagger 实现 API 文档，但在尝试运行应用程序时我不断遇到此堆栈跟踪： 有人可以详细说明一下为什么吗

如何检查某个操作是否允许匿名访问或是否仅授权？

我有一个使用 .NET 5 的基于 ASP.NET Core 的项目。我正在使用 SwaggerUI 生成文档。我需要实现 IOperationFilter 以将所需的参数添加到任何不...

如何在 Swagger 中获取枚举文档

我正在使用 Swagger API 文档，并希望在文档中包含我对枚举的描述。我正在使用自定义过滤器从类和枚举中提取信息，使用

go-gin 如何翻译 maxLength/minLength

我有一个简单的模式对象 SerialNumber 定义为： 序列号： 类型：对象 描述： | 实体的序列号。这是一个基本字符串，但有长度限制...

Swagger API：不应接受 Null

我已将以下内容添加到 api 的 swagger 定义中。 值：BooleanEnum = 查询（False，别名=“值”） 类 BooleanEnum(str, Enum): 真=“真” 假=&

为什么 Swagger UI 不显示具有特定名称的端点？

我在 Swagger UI 中有一个神秘的行为 当我将端点命名为“IDCard”时，它不会显示在 Swagger UI 中（尽管该端点可通过 Postman 调用！）： 然而，如果我命名它......

ASP。 NET Core Web API 项目没有将请求头“Authorization”生成到“swagger.json”文档文件中

ASP。 NET Core Web API项目没有将请求头“Authorization”生成到“swagger.json”文档文件中 尝试输出请求标头“Authorization&