Springboot集成swagger和knife
程序员文章站
2022-03-20 08:26:02
...
前言
knife4j是在swagger的基本上做做了一次封装,主要体现在ui表现,所有在使用前必须先搭建好swagger2,其实是swagger和knife都可以访问,
至于哪个好用全看个人!
swagger2
依赖包
compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'
compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.9.2'
//下面这两包是为了防止注解没有给默认值的时候抛出的警告日志
compile group: 'io.swagger', name: 'swagger-annotations', version: '1.5.22'
compile group: 'io.swagger', name: 'swagger-models', version: '1.5.22'
配置
@Getter
@Setter
@Configuration
@EnableSwagger2
@ConfigurationProperties("swagger")
public class SwaggerConfig {
private String host;//自定义host
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.only.oc.web.api"))//扫描包
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))//扫描在API注解的contorller
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))//扫描带ApiOperation注解的方法
.paths(PathSelectors.any())
.build().host(host);//自定义host
}
private ApiInfo apiInfo() {
String version = DateUtil.customFormat(new Date(),"yyyyMMdd.HHmmss");
return new ApiInfoBuilder()
.title("昂立课堂(业务版)")
.description("昂立课堂第二版,在SDK版上升级了业务模块,业务模块包括:用户、老师、学生、课程、课节、上课统计流水等。")
.version("v2."+version)
.license("Apache License Version 2.0")
.licenseUrl("https://www.apache.org/licenses/LICENSE-2.0")
.contact(new Contact("朱增亮", "", "aaa@qq.com"))
.build();
}
}
访问
默认访问路径
http://locahost:8080/swagger.html
knife4j
依赖包
compile group: 'com.github.xiaoymin', name: 'knife4j-spring-boot-starter', version: '2.0.4'
配置
原来的SwaggerConfig类上加入注解:
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
访问
默认访问路径
http://locahost:8080/doc.html
推荐阅读
-
SpringBoot整合Swagger和Actuator
-
Springboot集成接口文档swagger,使用,测试
-
SpringBoot集成Swagger UI从零搭建 + 配置 + 使用说明
-
SpringBoot集成Swagger2构建在线API文档的代码详解
-
SpringBoot同时集成swagger与knife4j2种API文档
-
springboot集成knife4j(swagger2)
-
springboot集成swagger-bootstrap-ui(knife4j)
-
十分钟搞定SpringBoot集成Swagger
-
springboot解决跨域和集成springsecurity解决跨域
-
关于springboot集成swagger及knife4j的增强问题