1、添加Swagger2的依赖
在pom.xml
中加入Swagger2的依赖
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.2.2</version> </dependency> <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.2.2</version> </dependency>
2、创建Swagger2配置类
在Application.java(SpringBoot项目启动文件)
同级创建Swagger2的配置类Swagger2.java
。
@Configuration @EnableSwagger2 public class Swagger2 {@Beanpublic Docket createRestApi(){return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.loong.controller")).paths(PathSelectors.any()).build();}private ApiInfo apiInfo(){return new ApiInfoBuilder().title("Spring Boot中使用Swagger2构建RESTful APIs").description("更多Spring Boot相关文章请关注:http://blog.didispace.com/").termsOfServiceUrl("http://blog.didispace.com/").contact("程序猿DD").version("1.0").build();}}
通过@Configuration
注解,让Spring来加载该类配置。再通过@EnableSwagger2
注解来启用Swagger2。
@ApiOperation
注解来给API增加说明。
@ApiImplicitParam
注解来给参数增加说明。
完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html(具体端口号根据自己指定的端口)