背景
公司最近在使用前后端分离开发项目,立马上手大名鼎鼎的Swagger生成API
现需要导出前后端接口文档
已经试过
Swagger2Marku
可以说,配置繁琐、依赖失效、无报错信息。。。。
难用的一批,谁用谁知道。。
正题
今天突然了解了另外一种方式,knife4j工具,集成了swagger,页面比swagger功能更多点,并且支持下载多种文档形式,pdf、md、word、html
- 引入依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-ui</artifactId>
<version>2.0.3</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.3</version>
</dependency>
- 创建Swagger配置文件
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
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
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket=new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//分组名称
.groupName("2.X版本")
.select()
//这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage("cn.ac.bcc.ebap.api"))
.paths(PathSelectors.any())
.build();
return docket;
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API")
.contact(new Contact("xxx", "https://blog.csdn.net/Mrkaizi", "qiyk@bcc.ac.cn"))
.description("管理API")
.version("1.0.0")
.termsOfServiceUrl("https://blog.csdn.net/Mrkaizi")
.build();
}
}
- 启动项目,访问 http://host:port/doc.html
感谢大佬造好的轮子!--------->knife4j官网地址