Swagger接口文档的使用:
官方网址:https://swagger.io/
使用步骤:
1、引入依赖:
dependency>
io.springfox
springfox-swagger2
2.9.2
io.springfox
springfox-swagger-ui
2.9.2
2、在工程中创建对应的包和类使用@EnableSwagger2 开启swagger2自动生成api文档功能
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2 //开启swagger2自动生成api文档的功能
public class AppSwggerConfig {
@Bean(“用户模块”)
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(“com.offcn.user.controller”))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("七易众筹-系统平台接口文档") .description("提供用户模块的文档") .termsOfServiceUrl("http://www.ujiuye.com/") .version("1.0") .build(); }
}