Springboot使用Swagger

1. 引入jar包

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.5.1.RELEASE</version>
</dependency>

2. Swagger2 配置

配置类如下：

@Configuration
@EnableSwagger2
public class swaggerConfig {
    //swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.rain.cookie.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("构建RESTful API")
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

使用时，只需在方法上加入相关注解即可

@ApiOperation("根据id查找用户信息")
@RequestMapping(value = "{id}", method = RequestMethod.GET)
public UserDTO user(@PathVariable("id") int id) {
   ……
}