问题标签 [springdoc-openapi-ui]

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 投票
1 回答
819 浏览

spring-boot - Springdoc-openapi。ClassNotFoundException:org.springframework.data.rest.webmvc.support.DefaultedPageable

将 Spring Boot 迁移到 3.1 版并将 springdoc-openapi 库迁移到 1.4.1 后:

  • springdoc-openapi-ui
  • springdoc-openapi-安全
  • springdoc-openapi-数据-rest

我遇到了问题ClassNotFoundException: org.springframework.data.rest.webmvc.support.DefaultedPageable

现在也在 Swagger UI 上@Entity生成了页面控制器和模式,但是之前只有来自@RestController、请求和响应 DTO 的端点。有没有办法禁用它?

0 投票
1 回答
46 浏览

openapi - 在哪里可以找到 springdoc 的 API 参考文档?

springdoc-openapijava 库是一个不错的库,用于将 Open API 3 与 Spring 项目(替代方案)集成springfox

我正在寻找参考文档(例如springfox除了官方网站,我什么也没找到。该网站很好地解释了库的使用,但不是完整的 API 参考。

还有一些不错的教程:BaeldungDZonePiotrminkowski Blog。但不是任何有组织的 API 参考文档。

有什么好的参考吗?

0 投票
3 回答
6068 浏览

spring-boot - Springdoc:打开 swagger-ui.html 时得到 404

我得到了最新的 Spring Boot 应用程序和 springdoc.swagger-ui。

我的 application.properties 包含 springdoc.swagger-ui.path=/swagger-ui-openapi.html

当我通过 Intellij IDEA 运行应用程序时,http://localhost:8080/swagger-ui-openapi.html将我带到http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/ swagger-config 和 Swagger UI 页面加载成功。

但是,如果我通过命令行启动应用程序:“java -jar my-app.jar”,当我尝试访问http://localhost:8080/时,我在浏览器中得到 404,并且在日志中出现错误 'Circular view path [error]' swagger-ui-openapi.html 并将我重定向到http://localhost:8080/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config

但是http://localhost:8080/v3/api-docs是可访问的,并且架构在此地址可用。

我怎样才能解决这个问题?

0 投票
1 回答
870 浏览

springdoc - 如何在 Spring Boot 和 Spring doc 中隐藏基于 Profiles 的端点?

我正在研究Spring Boot v2.2.2.RELEASE and SpringDoc UI and Open API Specification OAS3,我在这里发现了非常相关的问题:https ://github.com/springdoc/springdoc-openapi/issues/201 。

我有 4 个配置文件,分别是 Dev、Stage、UAT 和 Prod,并说我有 Student API、Employee API 和 Department API。

我想要 UAT 和 Prod 配置文件,我想隐藏部门 API。我们怎么能不呢?

0 投票
1 回答
3929 浏览

swagger-ui - 在 IE 上尝试迭代 SpringDoc Open API Swagger 的不可迭代实例的尝试无效

我最近将 swagger UI 从 更改SpringfoxSpringDoc OpenApi.

Swagger 在Chrome.

但是在Internet Explore我遇到错误时。My IE version is 11

在此处输入图像描述

0 投票
1 回答
3522 浏览

spring-boot - springdoc-openapi 中的隐藏参数不起作用

我有 2.3.0 版的 Spring Boot 应用程序。和 1.4.1 版中的 springdoc-openapi-webflux-ui。

我在这样的操作中注释了参数。

使用hidden = true我希望这个参数在 swagger-ui 中不可见。但它是。我误解了这个参数还是它没有做它应该做的事情?

我希望此参数位于 api-docs 中,以生成能够使用此参数的客户端,但我希望它在 swagger-ui 中不可见

0 投票
1 回答
24 浏览

springdoc - 如何设置 OAuth2.0 请求标头

我想在 SpringDoc Swagger 页面上放置一个值,如邮递员,并将其应用于所有请求

邮差

招摇-ui

并且预计 swagger 不会弹出用户名和密码的输入弹出窗口。

感谢所有的答案。

0 投票
1 回答
3574 浏览

swagger-ui - 如何在 Swagger-ui SpringDoc open ui 上对 Schemas 进行排序

我想对我Schemas为我的实体类生成的 DTO 类进行排序Springdoc ui
我可以通过文件中的以下配置对tagsand进行排序,但我的模式未按排序顺序。operationsyml

我怎么能对我的模式进行排序。
谢谢。

0 投票
1 回答
294 浏览

api - 是否有任何集中的方法来限制 api 在 openAPI 方面对 ui 的暴露?

我刚刚从 springfox 迁移到 spring-doc openAPI,现在它在我的 spring-boot 项目中公开了我们所有的 api 以获取文档。是否有任何集中的方式来管理该事情,因为在我们的情况下使用 @Hidden 注释是不可行的,因为我们必须修改我们的所有控制器。

任何建议将不胜感激。

0 投票
1 回答
335 浏览

spring-boot - SpringDoc (spring boot) utf-8 json 标头响应文档

我正在使用 springdoc(springdoc-openapi-ui)作为 kotlin spring boot 应用程序(Gradle build)的其余文档,我想知道是否有办法将响应标头内容类型编码设置为 utf-8。默认返回的内容类型为: Content-Type: application/json;charset=ISO-8859-1

问候。