问题标签 [springdoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
2 回答
1049 浏览

spring - 从 springfox 迁移到 springdoc 时为 Null ApiResponse

我正在尝试从springfox-swagger2(OpenAPI 2)迁移到springdoc-openapi-ui(OpenAPI 3),以生成招摇的文档。

这是一个示例路线:

大摇大摆的一代工作得很好springfox-swagger2,但是我遇到了以下问题springdoc

实际上,OpenAPI 尝试序列化以下对象:

如您所见,其中有一个空ApiResponse对象ApiResponses,奇怪的是有一个null键,然后序列化在 jackon 中失败MapSerializer.serialize()

无论我使用多少 Swagger 注释(@Operation添加@ApiResponse...),这个nullApiResponse 仍然存在。我不明白这是从哪里来的,尤其是suppressNull只影响values而不是keys,根据MapSerializer.serializeOptionalFields()

如何删除此null键控 ApiResponse ?

0 投票
1 回答
304 浏览

springdoc - SpringDoc Oauth2 需要隐式流随机数参数并且身份验证失败

我可以启用授权按钮,但是当我单击授权按钮时,对于 oauth2 隐式流程,它会抱怨缺少 nonce 参数。

这是我用来创建隐式流的代码

在 Springfox 中添加 nonce 参数,您为 SecurityConfiguration 创建一个 bean 并使用 additionalQueryStringsParams() 方法。

您将在其中添加 nonce 作为键和值对中的随机字符串。我尝试使用 OAuthFlows 和 SecurityScheme 上的扩展,但它似乎仍然无法正常工作。

我不确定我错过了什么,感谢任何帮助。

0 投票
1 回答
1940 浏览

springdoc - 从 Springdoc Open API 3 中的规范生成代码

我正在从 swagger (Open API 2) 迁移到 springdoc (Open API 3),但今天在某些情况下,我使用 swagger-codegen-maven-plugin 从 yaml 生成代码(用于客户端和提供者),遵循 Contract First 策略. 下面是配置示例:

是否有任何等效选项可以使用 springdoc-openapi-maven-plugin 生成代码?

0 投票
2 回答
2867 浏览

spring-boot - SpringDoc - 如何以编程方式添加模式

我正在使用 SpringDoc 并尝试以编程方式将模式添加到 OpenApi,但没有成功。

mySchema 的描述未添加到我在生成的 YAML 文件中看到的模式列表中,如果我尝试引用它:

swagger UI 中显示以下错误:

路径解析器错误。/XX/v1/test/status/{entry}.get.responses.404.headers.XxX.$ref 无法解析引用:无法解析指针:/components/schemas/MySchema

拜托,你能帮我理解吗?

编辑:我正在使用版本1.3.9

0 投票
1 回答
1521 浏览

java - 如何使用 Springdoc 在 OpenAPI 3.0 中创建链接?

我正在尝试为 OpenAPI 3.0 规范中的响应创建链接。更具体地说,我想提供我的一个响应与其他可用操作之间的已知关系(参见Link Object)。

在我的 Spring Boot 项目中,我使用 Springdoc(版本:1.3.9)来生成我的 API 文档。根据@ApiResponse#links文档,我尝试使用以下端点代码来实现我的目标:

不幸的是,我在 Swagger UI 中看不到任何结果,只有“无链接”描述。

没有链接

检查生成的 JSON 规范后,我也没有找到APIlinks的任何密钥。requestAvatar

在创建过程中我是否遗漏了一些东西,@Link或者 Springdoc 还不支持链接?

0 投票
1 回答
512 浏览

swagger - 嵌套复杂类型中的SpringDoc swagger文档生成异常

我们有一个 Person 类。Person 类有一个 PersonDetail 类型的属性。而且 PersonDetail 有一个 Mail 类的属性。

当我们启动应用程序并导航到 swagger ui html 页面时,未在 openapi 定义的组件部分生成 Mail 类,我们得到“无法解析引用:无法解析指针:/components/schemas/Mail 不存在于文档中”页面错误。当我们检查第三级是否存在复杂类型时,springdoc 无法解析该类型。Person 和 PersonDetail 工作正常,但 Mail 失败。

人员->人员详细信息->邮件

0 投票
2 回答
4336 浏览

spring-boot - springdoc-openapi swagger-ui 中的 CSRF 支持

当使用与 springdoc-openapi 捆绑的请求时,有没有办法自动将 CSRF 标头包含到从 swagger ui 发出的请求中?

在 springfox ( GitHub )中似乎实现了类似的解决方案,但我没有找到有关这是否可以通过 springdoc-openapi 完成的信息。

0 投票
1 回答
77 浏览

java - 开放API。Generic 的无效请求示例

如果用户通用,我会得到无效的请求示例和架构,但我得到有效的响应类型。

我怎样才能得到正确的看法?

附言。无效请求示例是仅具有来自父类/接口的字段的对象 - BaseObject

0 投票
3 回答
3203 浏览

swagger - 在 springdoc 中使用 openapi.yaml

我可以从代码自定义 OpenAPI 。
我可以像swagger-petstore
一样对 openapi.yaml 做同样的事情吗? 我用一个 @RestController 创建了简单的 springboot 项目。
我创建 openapi.yaml 并将其复制到 /src/main/resources/。
但是我在打开的 swagger-ui 页面上看到了默认值。

0 投票
2 回答
7986 浏览

java - 如何为 springdoc-openapi 端点调用添加带有授权的标头

Swagger2 (springfox) 与:

Springdoc-openapi:

我无法为 springdoc-openapi 实现它。似乎标题不起作用。