swagger 相关问题

Swagger是一个框架实现,用于基于Open API规范描述,生成,使用和可视化RESTful Web服务

Swagger @ApiResponses 作为常量值

我使用 swagger 创建一个 RESTful API,并有几个返回相同错误和响应的端点: @得到 @Path(“/一些/端点”) @ApiOperation( value =“某种方法”...

回答 2 投票 0

如何将自定义错误消息添加到 openapi 中自动生成的字段

如果我有一个 openapi 模式,其中包含以下条目 必需的: - 姓 特性: 姓: 类型:字符串 我得到生成的代码,例如 @NotNull() @Schema(name = "lastName&quo...

回答 1 投票 0

ASP.Net Open Api 指定端点部分

我通过最小的 api 生成端点,并尝试使用 Microsoft.AspNetCore.OpenApi 包生成文档,但我不知道如何设置一个部分,并且我的所有端点都出现在 sin...

回答 1 投票 0

根据 Swagger API 规范生成 Angular2 表单

我正在寻找一种从 Swagger API 定义文件生成一组 Angular2 表单模板的方法。我想要一个允许我测试我的 POST/PUT 请求,甚至在我的应用程序中使用它的结果。 一个...

回答 2 投票 0

Swagger-UI 的 AWS Cognito 登录

我们在 ourcompanyhostname.com/docs 公开托管我们的 API 文档。这对于我们发出 API 请求非常有用,并且已经取代了 Postman。我们目前的身份验证方式...

回答 1 投票 0

通过 flutter swagger_dart_code_generator 使用令牌身份验证

我目前正在学习 flutter 以及如何使用服务器后端开发移动应用程序。我遇到了 swagger_dart_code_generator 库,它基于

回答 1 投票 0

在 Springdoc 中自动生成基于 Swagger 注释的描述

基本上我的问题与这个相同,但是针对Springdoc(而不是Springfox)。 简而言之,我有一个 Spring-boot 应用程序,并且我正在使用 spring-security @PreAuthorize 注释来保护我的一些......

回答 1 投票 0

如何从 Visual Studio 中的 Swagger 文件更新 REST API 客户端

如何从 Visual Studio 中的 Swagger 文件更新 REST API 客户端?右键单击项目时,我通过“添加 -> REST API 客户端”菜单选项创建了 REST API 客户端。看截图

回答 3 投票 0

如何从 jsonresult 响应自动生成 OpenAPI 文档?

Swashbuckle可以根据代码自动生成API文档(有详细返回模型) [http获取] 公共 ActionResult> GetStudents() { 返回 CollegeReposi...

回答 1 投票 0

Swashbuckle.AspNetCore 必需的查询字符串参数

我有一个带有 Swashbuckle.AspNetCore 包的 ASP.NET Core v2.1 项目。 我的代码是: /// /// 为当前驱动程序设置新的android令牌 /// /// <

回答 3 投票 0

如何通过“隐藏”POST 字段记录 PUT

我正在尝试使用 swagger 来记录 API,但我很难弄清楚如何记录通过使用 POST 和所谓的隐藏 _method 参数来工作的 PUT/DELETE 方法,该参数表明...

回答 1 投票 0

如何为 FastAPI 中的每个端点生成独立的 Swagger UI 文档页面,而不是为一页中的所有端点生成 API 文档?

有没有办法在自己的页面上生成每个端点,而不是在单个页面上生成所有端点的文档,如下所示: 我想展示 GET 端点...

回答 1 投票 0

用于 PHP 数组的 Swagger

我正在尝试创建一个响应示例,该示例应返回如下数组: [ [ “店铺名称”, “53.7094190”, “-1.9084720” ,1 ] ] 为此,我使用以下代码: * @OA\Res...

回答 2 投票 0

如何防止 swagger 核心解析 Jackson 注释?

我有一个 FormTemplateElement 类,它有几个子类型。我希望仅使用 @Schema 注释来生成模式。然而 Swagger 也在解析 Jackson 注释......

回答 1 投票 0

Node.js 头盔和 swagger-ui

我正在 Node.js 中使用 swagger 来获取 API 文档。 现在我想使用头盔来确保安全,但是当我使用头盔时,会出现错误。 然而,如果我把头盔放在路由器下面大摇大摆,t...

回答 2 投票 0

使用带有 JsonNullable 字段的 mapstruct 时看不到该值

在我的mapstruct接口中,我有一个方法将Long转换为JsonNullable,这是swagger生成的类等待的类型(因为nullabe = true): 默认 JsonNullable 在我的mapstruct接口中,我有一个方法将Long转换为JsonNullable,这是由swagger生成的类等待的类型(因为nullabe = true): default JsonNullable<BigDecimal> map(Long value) { return value != null ? JsonNullable.of(BigDecimal.valueOf(value)) : JsonNullable.undefined(); } 当我处于调试状态时,没关系,JsonNullable 具有:present=true,value=80 例如。 当我使用休息客户端进行测试时,我在响应中没有值: "montant": { "present": true } 你知道为什么以及该怎么做吗? 谢谢 基于 jackson-databind-nullable 的自述文件 您应该在 Jackson 上注册该模块 JsonNullableModule ObjectMapper ObjectMapper mapper = new ObjectMapper(); mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); mapper.registerModule(new JsonNullableModule()); 不再以编程方式执行此操作,您可以定义模块的 bean: @Configuration public class JacksonConfiguration { @Bean public JsonNullableModule jsonNullableModule() { return new JsonNullableModule(); } } 这将自动注册,感谢 JacksonAutoConfiguration

回答 1 投票 0

无法从 Gitlab 内的 Swagger UI 调用外部 API。内容安全策略错误

我正在尝试在 GitLab 中使用 OpenAPI 文件(它为我的文件运行 UI),但是当我使用从 Swagger UI 尝试/执行功能(它向外部 API 发送请求)时,我收到错误与

回答 2 投票 0

如何使用 Swagger 以及 Nest.js API 和 SPA 之间共享的 DTO?

我有一个带有 Nest.js API 和 Angular SPA 的项目。 SPA 用于与 API 通信的 DTO 位于一个名为 Models 的单独项目中,我将其用作依赖项。这样一来,我...

回答 1 投票 0

使用 Swashbuckle.AspNetCore.Cli v6.4.0 生成 swagger.json 时出错

我已将此行添加到我的 .csproj 文件中 我已将此行添加到我的 .csproj 文件中 <Target Name="SwaggerPostBuildTarget" AfterTargets="PostBuildEvent"> <Exec Command="dotnet tool restore"></Exec> <Exec Command="dotnet tool install Swashbuckle.AspNetCore.Cli --version 6.4.0"></Exec> <Exec Command="dotnet swagger tofile --output swagger/v1/swagger.json $(OutputPath)$(AssemblyName).dll v1"></Exec> <Exec Command="dotnet swagger tofile --output swagger/v2/swagger.json $(OutputPath)$(AssemblyName).dll v2"></Exec> <Exec Command="dotnet swagger tofile --output swagger/v3/swagger.json $(OutputPath)$(AssemblyName).dll v3"></Exec> </Target> 当我运行该项目时,我收到此错误: MSB3073 - The command "dotnet swagger tofile --output /swagger/v1/swagger.json bin\Debug\net6.0\xxx.dll v1" exited with code -532462766 我一步步按照 https://github.com/domaindrivendev/Swashbuckle.AspNetCore#swashbuckleaspnetcorecli 中的说明进行操作,但它不起作用。 关于这个错误的含义有什么想法吗? 更新 通过更多尝试,我了解到在执行构建后命令时,环境变量尚未设置,这就是导致我的错误的原因,因为我尝试读取环境变量。 这是我的 launchsettings.json: 这是我执行的输出: 我还注意到,正在侦听的端口不是我设置的端口,但我无法理解从哪里读取它们 更新2 我发现了这个:如何在csproj文件中获取环境变量? 但它不起作用,我也无法得到澄清,因为我还不能发表评论。 github 上也有这个问题https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2290解释了为什么我会收到此错误,但我仍然无法在没有错误的情况下构建项目 更新3 我已经能够生成 json 文件。现在我的 csproj 文件中的说明如下所示: 我的 Program.cs 文件是: using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Mvc.ApiExplorer; using Microsoft.Extensions.DependencyInjection; var builder = WebApplication.CreateBuilder(args); // Custom configurations var startup = new Startup(builder.Configuration); startup.ConfigureServices(builder.Services); var app = builder.Build(); startup.Configure(app, app.Environment, app.Services.GetRequiredService<IApiVersionDescriptionProvider>()); app.Run(); 我需要重新安装我的 dotnet 工具。 尝试运行此命令:dotnet tool restore 对我来说,这是因为控制器中的两个操作方法共享相同的名称“ExampleOne”,如下所示 [HttpPost("example/apiOne", Name = "exampleOne")] [ProducesResponseType(StatusCodes.Status204NoContent)] public async Task<IActionResult> ActionMethodOne() { return NoContent(); } [HttpPost("example/apiTwo", Name = "exampleOne")] [ProducesResponseType(StatusCodes.Status204NoContent)] public async Task<IActionResult> ActionMethodTwo() { return NoContent(); } 如果您设置了 NUGET_PACKAGES 环境变量,我找到了另一种方法来获取此错误。 如果您的 nuget 包未缓存在默认位置(即 Windows 上的 %userprofile%\.nuget\packages),那么您可能会看到 The command "dotnet swagger..." exited with code 1. 我通过将以下文件夹复制回 nuget 默认位置来验证这一点: swashbuckle.aspnetcore swashbuckle.aspnetcore.cli swashbuckle.aspnetcore.swagger swashbuckle.aspnetcore.swaggergen swashbuckle.aspnetcore.swaggerui 这导致错误消失,但我不建议将其作为修复方法。相反,您可能应该删除 NUGET_PACKAGES 环境变量,以便将软件包安装在默认位置(并保持最新)。

回答 3 投票 0

Swagger 不处理 null 类型

问题:定义“可选枚举”的查询参数类型时,Swagger UI 不再显示下拉项。 Swagger(打字稿)代码生成器无法处理 null 类型 ei...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.