1剂跟、springBoot整合swagger
pom.xml文件加入依賴
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
application.yml文件加入配置
swagger:
basePackage: com.qianfeng.springboot.swagger
title: 圖書管理平臺API(設(shè)置標(biāo)題)
description: 書店平臺的REST API创淡,所有應(yīng)用程序都可以通過JSON訪問對象模型數(shù)據(jù)宰译。
contact: qianfeng
version: v1.0
url: http://www.1000phone.com
加入配置類结窘,加上注解@Configuration荠列、@EnableSwagger2
1昼丑、@value取yml以${}方式取配置文件中的屬性卵洗,
2、實(shí)體類可以加入@ApiModel(value ="用戶對象",description ="對應(yīng)用戶表")的注釋心肪,
3锭亏、controller的方法加入@ApiOperation(value ="查詢所有用戶")的注解可以配置描述信息
@Configuration
@EnableSwagger2
public class SwaggerConfig implements WebMvcConfigurer {
@Value("${swagger.basePackage}")
private String basePackage;
@Value("${swagger.title}")
private String title;
@Value("${swagger.version}")
private String version;
@Value("${swagger.description}")
private String description;
@Value("${swagger.concat}")
private String concat;
@Value("${swagger.url}")
private String url;
@Bean
? ? public Docket createApi(){
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(basePackage)).paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder().title(title).contact(concat).description(description).version(version).licenseUrl(url).build();
}
@Override
? ? public void addViewControllers(ViewControllerRegistry registry) {
registry.addRedirectViewController("/api","/swagger-ui.html");
}