springdoc openapi UI中的Swagger UI不会在生成的“@Controller”类中显示API

Question

我有一个Spring Boot应用程序，其中API被指定为OpenAPI 3.0.2 YAML文档。我使用openapi生成器maven插件从规范生成代码http://localhost:8080/swagger-用户界面。html，它显示：“规范中未定义任何操作！”

在规范中，我有：

servers:
    - url: /books/api/v1

这导致控制器类中出现以下情况：

@javax.annotation.Generated(value = "org.openapitools.codegen.languages.SpringCodegen", date = "2021-06-17T14:52:43.686820-07:00[America/Los_Angeles]")
@Controller
@RequestMapping("${openapi.axmPlatformKeyService.base-path:/books/api/v1}")
public class SvcApiController implements SvcApi {
    // ...
    // ...
}

如果我加载openapi定义。编辑亚马尔。大摇大摆io，它显示了预期的定义。

如果我这样创建另一个控制器：

@RestController
public class AddonController implements SvcApi {
    // ...
    // ...
}

然后Swagger UI显示了API，这基本上意味着如果生成的代码有“@RestController”，它会工作得很好。

因为生成的控制器是用@controller注释的，所以Swagger UI无法拾取它。即使在添加了这个额外的@RestController之后，Swagger UI的试用功能也不会在它生成的URL中包含“/books/api/v1”。

Net效果是使用这个AddonController，如果规范中有一个request/book/{id}，那么服务中有两个endpoint：

/books/api/v1/book/{id}/book/{id}

后者由Swagger UI调用。

这些是相关的依赖关系：

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

    <dependency>
      <groupId>io.swagger</groupId>
      <artifactId>swagger-annotations</artifactId>
      <version>1.6.2</version>
    </dependency>

Answer 1

添加一个静态初始值设定项

SpringDocUtils.getConfig().addRestControllers(SvcApiController.class) 

解决问题。在这种情况下不需要AddonController。