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(具體端口號根據自己指定的端口)