swagger 相关问题

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

添加 Swagger UI 供用户测试端点

这可能看起来是一个新手问题。 有没有办法在我的项目中使用 Swagger 用户界面? 这在本地主机中可能吗? 我想要一个界面供用户测试我的 API,看看是不是...

回答 1 投票 0

如何在非本地主机的内部开发环境中启用 swagger

我有一个 .NET 8 WEB API,它已被 Docker 化并在容器内运行。该容器被推送到 Azure ACR 并部署到 Azure AKS。 就功能而言,这很有效...

回答 1 投票 0

如何要求 Swagger UI 为每个端点全局添加不记名令牌字段?

由于此处描述的问题,我正在迁移到 Springdoc。现在在 Swagger UI 中,我没有每个端点的不记名令牌字段,但这是预期的,因为这些端点是安全的......

回答 2 投票 0

如何将Swagger添加到NopCommerce 4.5 API插件?

我已经为NopCommerce 4.5开发了API插件。是否可以为此 API 添加 Swagger 文档?怎样才能做到呢?

回答 1 投票 0

OpenAPI 3.0 如何将 dto 字段显示为查询参数

我正在从 Swagger 2.x 迁移到 OpenAPI 3.0,并遇到了一些麻烦:我使用 ApiModel 和 ApiModelProperties 将 dto 字段显示为方法的参数,但现在它只显示...

回答 1 投票 0

Swagger 接受定义的 @JsonProperty 字段名称并自动生成一个

我有一个请求类: 数据类 RegisterDto( @JsonProperty(“名字”) var 名字:字符串, @JsonProperty(“姓氏”) var 姓氏:St...

回答 2 投票 0

如何在基于函数的视图中使用 django Rest 框架和 drf_spectaulous 显示请求正文

我遇到以下问题,这对我来说很难找到基于函数的视图的文档来用 drf_spectaulous 记录它们,因为所有这些都是针对基于类的视图找到的 我有

回答 1 投票 0

如何让 springdoc-openapi 在不更改 toString 的情况下使用 @JsonValue 枚举格式?

我有一个 Spring Boot 应用程序,使用 springdoc-openapi 为我的控制器生成 Swagger API 文档。 JSON 请求/响应中使用的枚举之一具有不同的 JSON 表示...

回答 3 投票 0

JsonIgnore 使用开放 API 规范

我使用 OpenAPI 规范来生成 Java POJO。我需要在 Open API yaml 中指定什么才能生成以下 POJO 的等效项? ... @JsonIgnore 公共字符串被忽略的属性; ... 我有 yaml ...

回答 2 投票 0

openapi-spec-validator 无法验证 swagger:2.0 API 规范

我们决定从使用 swagger-cli 转向 openapi-spec-validator 来验证我们的 API 规范,因为 swagger-cli 似乎已被弃用。 以下规范因 openapi-spec-validator 失败, abcd-规格....

回答 1 投票 0

默认将 JSON 值声明为 null

我有一个带有 POST 方法的 python API,它的输入 JSON 结构如下: { “富”:0, “酒吧”:0, “巴兹”:“字符串”, } 但这些默认值...

回答 1 投票 0

在 Swagger Nestjs 中创建自定义响应

我的控制器带有 @Post('电子邮件/注册') @HttpCode(HttpStatus.CREATED) @ApiOkResponse(AuthConfigSwagger.API_OP_CREATE) @ApiCreatedResponse(AuthConfigSwagger.API_RES_CREATE) 异步

回答 2 投票 0

java swagger 3 jsonfile 中的 @ExampleObject 注释

我正在记录我的 api 之一,其中包含多个示例,如下所示: @Operation(summary = "新建") @PostMapping("") 公共 ResponseEntity createOne( @参数... 我正在用多个这样的示例来记录我的 api 之一: @Operation(summary = "Create new") @PostMapping("") public ResponseEntity<Object> createOne( @Parameter(description = "MyDto") @io.swagger.v3.oas.annotations.parameters.RequestBody( content = @Content(examples = { @ExampleObject(name = "one", value = EXAMPLE_ONE), @ExampleObject(name = "two", value = EXAMPLE_TWO), @ExampleObject(name = "three", value = EXAMPLE_THREE)} )) @RequestBody MyDTO body ) { ... } 虽然 Examples_ONE 是一个字符串值,但效果很好。正如您从下面的示例中看到的那样,这非常不清楚 private static final String EXAMPLE_ONE = "{\"glossary\":{\"title\":\"example glossary\",\"GlossDiv\":{\"title\":\"S\",\"GlossList\":{\"GlossEntry\":{\"ID\":\"SGML\",\"SortAs\":\"SGML\",\"GlossTerm\":\"Standard Generalized Markup Language\",\"Acronym\":\"SGML\",\"Abbrev\":\"ISO 8879:1986\",\"GlossDef\":{\"para\":\"A meta-markup language, used to create markup languages such as DocBook.\",\"GlossSeeAlso\":[\"GML\",\"XML\"]},\"GlossSee\":\"markup\"}}}}}"; 我正在寻找更好的方法来提供示例。 json 文件会很好,但我找不到任何相关内容。 使用java文本块代替普通的带引号的字符串 例如投入三双(“””) 请参阅https://www.baeldung.com/java-text-blocks 您可以使用 externalValue 代替 value。请参阅此处 在类的 static{} 期间使用 Java 文本块,或将文件加载到字符串中。 您可以使用我的实用程序来实现此目的。

回答 3 投票 0

SWAGGER BUG:只允许一个参数(!已解决)

我的路线有这个选项,当访问第一个参数(页面)时,它会正确返回从 swagger ui 输入的值,当它访问第二个参数(流派)时,它会直接将其解释为 st...

回答 2 投票 0

在打字稿/节点中swagger多个参数定义

我的路线有这个选项,当访问第一个参数(页面)时,它会正确返回从 swagger ui 输入的值,当它访问第二个参数(流派)时,它会直接将其解释为 st...

回答 1 投票 0

ASP.NET Core 8 最小 API - 使用 jwt 进行 Swagger

显示授权按钮,但如果我粘贴有效的 JWT 令牌,我会得到: 错误:未经授权 内容长度:0 日期: 2024 年 5 月 12 日,星期日 21:37:28 GMT 服务器:凯斯特雷尔 www-authenticate:承载者 我...

回答 1 投票 0

Swagger UI 显示 LocalDateTime(单位为毫秒),尽管有格式规范

我在 Spring Boot 应用程序中遇到了 Swagger UI 的问题,尽管指定了没有

回答 1 投票 0

nest-cli @nestjs/swagger 插件不起作用

“@nestjs/swagger”:“^5.2.0”,CLI 插件未注释所有 dtos 和 schemas 类。 嵌套-cli.json { “集合”:“@nestjs/schematics”, "sourceRoot": "src", ”

回答 3 投票 0

Openapi 生成器:是否可以从自动生成的代码参数中排除某些标头?

我想支持一些“基础设施”标头并使用它们来描述我的 api,但是在生成阶段,我不希望这些标头在代码中显示为参数。 我会照顾你的...

回答 2 投票 0

Swagger 代码生成 - 包 javax.annotation 不存在

为什么 swagger-codegen 生成的项目缺少依赖项? 跑步: java -jar swagger-codegen-cli.jar 生成 -l java -i swagger.json 例如生成一个项目: @javax。

回答 3 投票 0

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