1 pom依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2 配置文件
用于配置ui界面的标题、详情等等内容,在当下的版本该内容只能通过配置文件的形式使用,注解做不到!
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
private ApiInfo createAI(){
return new ApiInfoBuilder().title("笑话大全接口xudaidai").description("基于SpringBoot+MybatisPlus实现的xiaohua").version("0.1")
.contact(new Contact("xude","http://xudaidai.xyz","980234608@qq.com")).build();
}
@Bean
public Docket createD(){
return new Docket(DocumentationType.SWAGGER_2).apiInfo(createAI()).select().apis
(RequestHandlerSelectors.basePackage("com.xude.joker.controller")).build();
}
}
3 注解的使用
在启动类上加注解:@EnableSwagger2
实体上用注解: @ApiModel
实体类字段:@ApiModelProperty
controller层类上注解:@Api
controller层方法上注解:@ApiOperation