配置Swagger

1 引入依赖包

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.7.0</version>
</dependency>
<dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.7.0</version>
</dependency>

 

2 在config中添加配置类

 

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .build();

    }

    private ApiInfo webApiInfo(){

        return new ApiInfoBuilder()
                .title("网站-讲师API文档")
                .description("本文档描述了讲师服务接口定义")
                .version("1.0")
                .contact("填入数据")
                .build();
    }
}

 　　这个配置类一般都是固定的, 我们只需要直接赋值粘贴使用即可, 对于一些描述性的东西, 我们按照要求填入就好

 

3 使用

　　在相应的地方使用最基本的四个注解:

　　　　@Api

　　　　@ApiModel

　　　　@ApiOperation

　　　　@ApiParam