什么是swagger :
Swagger 是一系列 RESTful API 的工具,通过 Swagger 可以获得项目的一种交互式文档,客户端 SDK 的自动生成等功能
在springboot中使用注解来标记出需要在 API 文档中展示的信息,Swagger 会根据项目中标记的注解来生成对应的 API 文档。
大大的解决了我们开发完接口,还要写接口文档的麻烦。
1.在 pom.xml 配置依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
想要使用它需要先配置
2.编写一个配置类
package com.springboot.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration //该注解是标记这个是一个配置文件类
@EnableSwagger2 //项目启用 swagger
public class SwaggerConfig {
@Bean //Docket对象加入到spring容器中
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.springboot.demo"))//自己项目的包
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("学生管理")
.description("学生管理系统 API 1.0 操作文档")
.termsOfServiceUrl("http://localhost:8080/")
.version("1.0")
.contact(new Contact("测试swagger", "http://localhost:8080/", "12345674897@qq.com"))
.build();
}
}
3.启动项目访问
http://localhost:8080/swagger-ui.html#/