问题标签 [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 回答
807 浏览

spring-boot - 启用 /oauth/token 端点 springdoc-openapi-ui

我正在从升级springfox-swagger2springdoc-openapi-ui. 我使用前端的 swagger 定义来自动生成类型。中/oauth/token缺少端点springdoc-openapi-ui。这是我的配置:

我有一个身份验证服务器,它是同一应用程序的一部分(pom.xml与我的资源服务器共享相同。身份验证服务器spring-security-oauth2如下:

我的资源服务器如下所示:

因此,安全配置非常基础,因为资源服务器定义了大部分内容:

0 投票
1 回答
2083 浏览

spring-boot - Spring Boot REST API: SpringDoc + OpenAPI 3 (springdoc-openapi-ui) or Swagger2 v3 (springfox-boot-starter)

There are 2 ways to add OpenAPI 3 into Spring Boot project.

https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/

https://medium.com/@hala3k/setting-up-swagger-3-with-spring-boot-2-a7c1c3151545

There are aloso migration isue for config and annotation

The question is: are there any reasons for Spring Boot project to make a choice beetwen them?

UPDATE: make migration to OpenAPI 3. Not too hard:) Maybe it will be helpfull:

OpenApiConfig, pom.xml, Описание

0 投票
1 回答
202 浏览

swagger-ui - 如何在隐式 Oauth2 流的授权 URL 中将 response_type 更改为 id_token

我有以下 OpenAPI 配置

当我单击招摇 UI 上的授权按钮时,它正在生成以下 URL

我想要 response_type 作为 id_token 代替令牌。有什么办法可以改变吗?

0 投票
1 回答
813 浏览

java - 如何将 Springdoc Swagger UI 指向我自己的 YAML 文件而不是自动生成的文件?

我创建了一个 Spring Boot RESTFul 微服务,对于文档,我创建了一个 swagger.yaml 文件,但我不知道如何运行该文件。为了创建 swagger.yaml 文件,我使用了 OpenAPI 规范。我知道我们有一个 Swagger UI 功能可以使用,但我想运行我自己创建的 swagger.yaml 文件,只是为了摆脱大量注释。

0 投票
2 回答
990 浏览

spring-boot - 如何使用 swagger OpenAPI 注释将描述设置为字段

为了改进我们的 api 文档,我想在响应正文的字段中添加描述

作为示例,请参阅此处的默认 petstore 规范: https ://editor.swagger.io/

在宠物响应中的 POST /pet 中,状态具有描述“商店中的宠物状态”

如何从代码库中的注释角度执行此操作?

(招摇v3)

0 投票
2 回答
8249 浏览

springdoc - 我已经使用 springdoc 安装了 OpenAPI 3,但是 URL 很奇怪。我可以将其更改为预期值吗?

我在我的 Java 项目的 pom 文件中使用以下工件安装了 swagger-ui:

当我转到此 URL 时,我可以查看我的 RESTful 端点的 swagger ui

但不是这个链接

为什么是这样?如何将其更改回预期的 URL?

0 投票
1 回答
227 浏览

java - Springdoc中基于Swagger注解的自动描述生成

基本上我的问题与这个问题相同,但对于 Springdoc(而不是 Springfox)。

简而言之,我有一个 Spring-boot 应用程序,我正在使用 spring-security @PreAuthorize 注释来保护我的一些 api,目前hasAuthority仅基于。

有没有办法可以根据注释自动修改特定的资源招摇描述?我想这与覆盖 Springdoc 的默认类行为之一有关(也许OpenAPICustomiser?),但我不知道该怎么做。

0 投票
0 回答
388 浏览

spring-webflux - springdoc-openapi-maven-plugin 与 spring.webflux.base-path 一起使用时不生成输出文件

我有一个使用 Webflux 的 Maven Spring Boot 项目。springdoc-openapi-maven-plugin我在我的 pom 中使用将打开的 api 规范生成到输出文件中:

我还在我的 pom 中添加了springdoc-openapi-webflux-ui依赖项:

上述设置一切正常,openapi.json每次编译时都会生成一个新文件。

但是,我需要为所有 API 路径添加前缀。所以我最终spring.webflux.base-path在我的文件中添加了一个属性application.yml,它按预期工作。

一旦我这样做了,open api 就无法再生成输出文件 ( openapi.json)。这是预期的吗?有没有办法调试开放 api 相关的错误?

0 投票
0 回答
462 浏览

java - 在服务器 open-api 上看不到 swagger-ui.html

我正在使用 Spring-Boot 2.xx、gradle 6、Java 8

我想使用 Openapi UI 而不是 Swagger 2 作为文档

Swagger 2 没有这些问题

并且 swagger-ui.html 可在

但是在带有 docker 容器的 Kubernetes 上,该服务可以像

并且 open-api 文档不起作用

如果我添加重定向 url 一些额外的东西

Open api的页面将无内容可用

最后,如果我在探索部分添加这个

不仅

有用

如何解决?

我想添加一些参数来获得 swagger-ui

0 投票
1 回答
151 浏览

springdoc-openapi-ui - @RestController实现任何接口时无法生成api-doc - springdoc-openapi-ui

关于我的项目的信息:

  • 打开 Java 11.01
  • springdoc-openapi-ui 1.5.2
  • Spring 核心 5.1.2.RELEASE
  • 春季启动 2.1.0.RELEASE

有了这个没有实现这个接口的控制器,我可以生成这个 API 文档:

生成的文档:

但是有了这个界面:

我有这个错误:

知道为什么吗?

我试图将这个 Getter 注释迁移到接口等,但仍然是同样的错误。