knife4j的简单使用
文章目录
1.使用环境:spring5.;spring-boot2.;spring-cloud阿里巴巴系
2.引入依赖pom.xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-dependencies</artifactId>
<version>2.0.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<!--knife4j引入 start-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>
<!--knife4j引入 end-->
</dependencies>3.配置自定义markdown文档 application.yml
knife4j:
markdowns: classpath:markdown/*
basic:
enable: false
username: zhangsan
password: 1111114.配置分组
import com.fasterxml.classmate.TypeResolver;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.context.request.async.DeferredResult;
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;
import java.lang.reflect.WildcardType;
import static springfox.documentation.schema.AlternateTypeRules.newRule;
@Configuration
@EnableSwagger2
@EnableKnife4j
public class Swagger2Config {
@Autowired
private TypeResolver typeResolver;
@Bean
public Docket productApi() {
// 添加header参数
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(metaData())
//分组名称
.groupName("示例分组")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.byd.mes.assembly.controller"))
//.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
.paths(PathSelectors.any())
.build()
.alternateTypeRules( //自定义规则,如果遇到DeferredResult,则把泛型类转成json
newRule(typeResolver.resolve(DeferredResult.class,
typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
typeResolver.resolve(WildcardType.class)));
}
@Bean
public Docket BaseInfoApi() {
// 添加header参数
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(metaData())
//分组名称
.groupName("总装基础信息")
.select()
.paths(PathSelectors.ant("/api/v1/**"))
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("com.byd.mes.assembly.controller.BASE"))
//.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
.paths(PathSelectors.any())
.build()
.alternateTypeRules( //自定义规则,如果遇到DeferredResult,则把泛型类转成json
newRule(typeResolver.resolve(DeferredResult.class,
typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
typeResolver.resolve(WildcardType.class)));
}
private ApiInfo metaData() {
return new ApiInfoBuilder()
.title("MES API 接口文档")
.description("基于REST接口风格接口文档")
.termsOfServiceUrl("http://localhost:12801/doc.html#/home")
.version("1.0")
.contact(new Contact(
"lxc",
"http://localhost:****/doc.html#/home",
""))
.build();
}
}
5.访问文档
http://{IP}:{端口号}/{项目名}/doc.html

评论
登录后参与技术讨论,分享你的经验与见解。
登录 / 注册暂无评论