Springfox - 如果控制器中未使用它,是否可以通过注释记录 POJO
Springfox - Is it possible to document a POJO via annotation if it's not used in a controller
正如标题所说,如果 POJO 未在控制器方法中使用,是否可以在 swagger 文档中包含它?
我试过在 POJO class 上使用 @ApiModel 注释,即:
@ApiModel("POJO")
public class Pojo {
...
}
但是,除非 POJO 由控制器返回,否则我无法让它出现在生成的 swagger 文档中。有办法实现吗?
顺便说一句,我使用的是 springfox 版本 2.9.2。
使用 Springfox 是可能的。你只需要修改你的Docket
。将 additionalModels
方法添加到您的 Docket
实现中:
@Autowired
private TypeResolver resolver;
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
...
.additionalModels(resolver.resolve(Pojo.class));
}
正如标题所说,如果 POJO 未在控制器方法中使用,是否可以在 swagger 文档中包含它?
我试过在 POJO class 上使用 @ApiModel 注释,即:
@ApiModel("POJO")
public class Pojo {
...
}
但是,除非 POJO 由控制器返回,否则我无法让它出现在生成的 swagger 文档中。有办法实现吗?
顺便说一句,我使用的是 springfox 版本 2.9.2。
使用 Springfox 是可能的。你只需要修改你的Docket
。将 additionalModels
方法添加到您的 Docket
实现中:
@Autowired
private TypeResolver resolver;
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
...
.additionalModels(resolver.resolve(Pojo.class));
}