标签: springdoc-openapi-ui

我正在使用 Spring Boot 和 Open API 3。当我发出 POST 请求时，通过 OAS2 Swagger，我看到所有字符串字段都以 Spring 的默认值出现，并且我没有看到通过 SpringDoc Open UI 删除它的方法也不通过代码。

{
  "firstName": "string",
  "lastName": "string",
  "age": 0,
  "email": "string",
  "address1": "string",
  "address2": "string",
  "address3": "string",
  "telephone" : "0",
  "department" : "string",
  .....
}

这里消费者不愿意在发出请求时从字段中删除字符串。有什么办法吗

1. 如果我们可以删除“string”作为值并将 null 或“”设置为默认值？
2. 如果我们可以读取自定义对象并将找到“字符串”的所有值重置为 null，有什么办法吗？

我正在研究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 配置文件，我想隐藏 Department API。怎能不呢？

我已使用 RouterOperation 将 Swagger (OpenAPI) 与 Spring Webflux 集成，如下所述： https: //springdoc.org/#spring-weblfuxwebmvcfn-with-function-endpoints。集成工作正常，可通过 /swagger-ui.html 访问

但是，对于 POST API，当我单击“试用”按钮时，我没有看到“请求”示例。我的 Post API 接受 Json 作为请求正文。

我该如何配置这个？可以通过注释和 RouterOperation 或其他方式来完成吗？

编辑：下面是我的 Router 类代码：

@Configuration
public class  MyRouter {

    @RouterOperations({
            @RouterOperation(path = "/data", beanClass = MyHandler.class, beanMethod = "getData"),
            @RouterOperation(path = "/allData", beanClass = MyHandler.class, beanMethod = "getAllData") })

    @Bean
    public RouterFunction<ServerResponse> route(MyHandler MyHandler) {

        return RouterFunctions
                .route(RequestPredicates.POST("/data").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), MyHandler::getData)
                .andRoute(RequestPredicates.GET("/allData").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), MyHandler::getAllData);
    }
}

添加 RouterOperations 注释后，我可以看到 swagger-ui 正确显示 GET 和 POST API，但没有显示请求架构示例。

我还遇到了 yaml / json …

基本上我的问题与此相同，但针对 Springdoc （而不是 Springfox）。

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

有没有办法可以根据注解自动修改具体的资源swagger描述？我想这与重写 Springdoc 的默认类行为之一有关（也许OpenAPICustomiser？），但我不确定如何做到这一点。

我在 Springdoc 生成的 OpenAPI 规范中遇到验证错误，并且无法在网上找到与我的 Java 代码的形成方式相匹配的示例。

我正在尝试使用 Springdoc 为 Spring Boot 控制器生成 OpenAPI 规范。我有一个具有多个路径变量的路径的映射，并且方法签名接受命令对象（命令对象是从这些路径变量自动构造的）。Swagger-UI.html 似乎或多或少可以工作，但生成的 JSON/YAML 规范似乎无效。

我指的代码片段：

@GetMapping("/myPath/{foo}/{bar}/{baz}")
public Mono<MyServiceResponse> doSomethingInteresting(@Valid DoSomethingInterestingCommand command) {
    return interestingService.doSomethingInteresting(command);
}

生成的 OpenApi 片段是：

paths:
  '/myPath/{foo}/{bar}/{baz}':
    get:
      tags:
        - my-controller
      operationId: doSomethingInteresting
      parameters:
        - name: command
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/DoSomethingInterestingCommand'

这会产生如下错误：

Semantic error at paths./myPath/{foo}/{bar}/{baz}
Declared path parameter "foo" needs to be defined as a path parameter at either the path or operation level

为了使生成的规范格式良好，我应该采取哪些不同的做法？我也很好奇为什么 swagger-ui.html 页面似乎工作正常，但这并不那么重要。

我在 Spring Boot 中通过 Openapi 打开 swagger-ui 时遇到问题。

当我尝试打开此 URL http://localhost:8080/swagger-ui.html 时，我收到Whitelabel 错误页面

我该如何解决这个问题？

这是pom.xml中定义的依赖项，如下所示。

<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-ui</artifactId>
    <version>1.6.4</version>
</dependency>

@Configuration
public class OpenApiConfig {

    @Bean
    public OpenAPI customOpenAPI(@Value("${application-description}") String description,
                                 @Value("${application-version}") String version) {
        return new OpenAPI()
                .info(new Info().title("API")
                        .version(version)
                        .description(description)
                        .license(new License().name("API Licence")));
    }
}

springdoc.swagger-ui.path=/swagger-ui.html
application-description=API Description
application-version=1.0

logging.level.org.springframework.web=DEBUG
logging.level.io.springfox=DEBUG

2023-02-09T08:36:16.593+03:00 DEBUG 20184 --- [nio-8080-exec-4] o.s.web.servlet.DispatcherServlet        : GET "/swagger-ui.html", parameters={}
2023-02-09T08:36:16.594+03:00 …