gitee教程地址:knife4j: knife4j是为Java MVC框架集成Swagger生成Api文档的工具,前身是swagger-bootstrap-ui
第一步:在pom.xml中添加
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
第二步:添加SwaggerConfig类
package com.member.config;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import io.swagger.annotations.ApiOperation;
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;
/**
* 访问地址 http://127.0.0.1:8010/doc.html
* 访问地址 http://127.0.0.1:自己配置的端口号/doc.html
*/
@Configuration
@EnableSwagger2
@EnableKnife4j
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.useDefaultResponseMessages(false)
.apiInfo(apiInfo())
.select()
//方式一: 配置扫描 所有想在swagger界面的统一管理接口。都必须在此包下
//.apis(RequestHandlerSelectors.basePackage("com.baozun.dma.collection.delivery.controller"))
//方式二: 只有当方法上有 @ApiOperation 注解时才能生成对应的接口文档
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Knife4j APIs")
.description("swagger-bootstrap-ui")
.termsOfServiceUrl("http://localhost:2888/")
.version("1.0")
.build();
}
}
第三步:创建controller类 写上添加@Api @ApiOperation
第四步:访问地址 http://127.0.0.1:自己配置的端口号/doc.html