1.在pom.xml中导入依赖
<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.在Controller类中加注解
1.在类名上添加注解 @Api(tags = "生成验证码")
@EnableSwagger2
public class CodeController 2.在方法名上添加注解 ①参数少的时候,用: @ApiOperation(value = "获取验证码", httpMethod = "GET", produces = "application/json;charset=UTF-8")
@ApiImplicitParam(value = "时间戳", name = "timestamp") ②参数多的时候,用: @ApiOperation(value = "判断验证码", httpMethod = "GET", produces = "application/json;charset=UTF-8")
@ApiImplicitParams(value = {@ApiImplicitParam(value = "验证验证码", name = "validateCode"),
@ApiImplicitParam(value = "时间戳(疑似不用)", name = "timestamp")}) 3.在和controller包同目录下创建config包,存放SwaggerConfig,代码如下:
package config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import springfox.documentation.RequestHandler; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 @EnableWebMvc //扫描的API Controller包 @ComponentScan(basePackages = "config") public class SwaggerConfig { // 接口文档构建配置 @Bean public Docket createRestApi(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select()//选择那些路径和api会生成document .apis(RequestHandlerSelectors.basePackage("controller"))//对controller包下的API进行监控 .paths(PathSelectors.any())//对所有路径进行监控 .build(); } //接口文档信息 private ApiInfo apiInfo(){ return new ApiInfoBuilder() .title("RESTFUL API服务接口列表") .description("API接口") .version("1.0") .build(); } } |
|
然后启动项目,访问http://localhost:8080/项目名/swagger-ui.html。即可