Swagger (Springfox) 只找到在 Controller @RequestBody (Spring Boot) 中使用的模型

Question

基本上，我感兴趣的是，Swagger 在 swagger-ui 中显示的唯一模型是否是 RestController 方法中使用的模型。它检测到我用@RequestBody 填充的两个 DTO，但它没有检测到用户模型，即使使用 ApiModel 注释也是如此。如何在不制作虚拟控制器方法的情况下解决这个问题？

例如：

@PostMapping("/signin")
@ApiOperation
public String login(
        @ApiParam(value = "The login credentials DTO (username and password)", required = true) 
        @RequestBody
        @Valid LoginCredentialsDTO loginCredentialsDTO) {
    return userService.login(loginCredentialsDTO);
}

它检测到模型 "LoginCredentialsDTO" 因为它在控制器方法中被使用了。

因为我只在我的控制器中使用 DTO，所以它没有检测到我的主要模型（用户）。我不想为了 Swagger 能够检测到我所有的模型而必须制作一个虚拟方法。

Answer 1

Swagger 描述了您的 api 的外部接口。当您的用户模型不在外部使用时，将不可见。另见招摇。io/docs/specification/2-0/basic-structure

Swagger (Springfox) 只找到在 Controller @RequestBody (Spring Boot) 中使用的模型

Swagger (Springfox) only finding Models used in Controller @RequestBody (Spring Boot)

java

rest

swagger

spring-boot

springfox