配置加载com.github.xiaoymin knife4j-spring-boot-starter2.0.3
package com.pengsn.apiserver.videoconference.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.import;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
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())
.select()
// 这里指定Controller扫描包路径
.apis(RequestHandlerSelectors.basePackage(
"com.pengsn.apiserver.videoconference.business"))
.paths(PathSelectors.any()).build();
return docket;
}
private ApiInfo apiInfo() {
Contact contact = new Contact("pengsn", "", "");
return new ApiInfoBuilder().title("视频会议接口描述").
description("视频会议接口描述").contact(contact).version("1.0").build();
}
}
注解使用
- @Api(tags="controller description"); 作用于 类
- @ApiOperator(value="接口名称", notes="接口描述") 作用于 方法
- @ApiOperationSupport(order=1) 排序
以上就是Springboot集成knife4j实现风格化API文档的详细内容,更多关于Springboot集成knife4j的资料请关注考高分网其它相关文章!



