swagger 相关问题

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

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

在 nginx 代理后面托管 swagger-ui

我们有一个设置,我们使用 Spring Boot 3.1.5 部署了 springdoc-openapi-starter-webmvc-ui。 Spring Boot 服务器在端口 8080 上运行。我们设置了 nginx,以便所有请求都...

回答 1 投票 0

访问http://localhost:8080/swagger-ui/index.html时遇到Whitelabel错误页面

我正在学习如何在 Spring Boot 3.25 中使用 Swagger 3。我可以访问http://localhost:8080/rad并且可以获取测试数据。 我的依赖 ...

回答 1 投票 0

Swagger-ui 锚链接到模型定义

是否可以直接通过锚点访问via swagger-ui的模型定义? 在示例页面 http://petstore.swagger.io/ 中,我看到锚点适用于一组端点,例如 哈...

回答 2 投票 0

如何使用样式 simple + 路径变量作为 Object 来执行 swagger 请求验证

我想使用 Open API 3.0.0 执行 swagger 请求验证,样式简单,路径变量作为对象。 根据 swagger 官方文档,我想在我的 API 中进行以下配置...

回答 1 投票 0

当 multipart/form-data 具有字符串枚举时,autorest 模型生成失败

我正在尝试使用 openapi 规范 yaml 生成 C# 模型和客户端 如果我在 multipart/form-data 中有一个枚举类型的属性,如下所示: 请求正文: 必填:真实 c...

回答 1 投票 0

NestJs Swagger for Postman

有没有办法将生成的swagger.json作为集合导入到Postman中? 我尝试导入它,但端点未显示在 Postman 中? 我正在使用 NestJs 和 Swagger + Postman

回答 3 投票 0

swagger widdershins slate html 标记问题

我需要将swagger文件编译成html文件。我愿意: 在 editor.swagger.io 上创建 json 文件。 通过命令生成markdown: widdershins endpoint.json -o ./endpoint.html.md 然后生成html...

回答 1 投票 0

我可以删除响应架构表吗?只需保留示例值

我正在通过 YAML 使用 Swagger 3.0.0 创建一个文档 Api,通过 Widdershins 转换为 markdown,然后通过 Slate 构建为 HTML。 我可以删除或隐藏响应架构表并继续显示示例值吗...

回答 1 投票 0

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