1.pom引入swagger2依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
2.编写swagger配置类:
特别要注意的是里面配置了api文件也就是controller包的路径,不然生成的文档扫描不到接口。
package lf.ssm.config;
@Configuration
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("lf.ssm.controller"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("springboot利用swagger构建api文档")
.description("简单优雅的restfun风格,https://me.csdn.net/qq_42154902")
.termsOfServiceUrl("https://me.csdn.net/qq_42154902")
.version("2.6")
.build();
}
}
3.在Application主应用类上加上注解@EnableSwagger2表示开启Swagger
@SpringBootApplication
@EnableSwagger2
public class SpringbootSwagger2Application {
public static void main(String[] args) {
SpringApplication.run(SpringbootSwagger2Application.class, args);
}
}
4.使用:
@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam:单个参数描述
@ApiModel:用对象来接收参数
@ApiProperty:用对象接收参数时,描述对象的一个字段
@ApiResponse:HTTP响应其中1个描述
@ApiResponses:HTTP响应整体描述
@ApiIgnore:使用该注解忽略这个API
@ApiError :发生错误返回的信息
@ApiImplicitParam:一个请求参数
@ApiImplicitParams:多个请求参数
@RestController
@Api(description = "用户控制器",tags = "BaseController")
@RequestMapping("/swagger")
public class TestSwaggerController extends BaseController{
@Autowired
private UserService userService;
@ApiOperation(value="获取用户列表",notes = "根据page,limit获取用户列表")
@GetMapping("/")
public BaseResult userList(String page,String limit){
List<User> all = userService.findAll();
return new BaseResult().setData(all);
}
}
4.访问
http://localhost:8080/swagger-ui.html