第一步:引入依赖
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>${knife4j.version}</version>
</dependency>
第二部配置
第三步:访问
http://localhost:8002/doc.html
import java.util.List;
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.EnableSwaggerBootstrapUi;
import com.google.common.collect.Lists;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
* @author: zhangsy
* @date: 2021-05-21 14:34
* @description:
*/
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUi
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {
@Bean
public Docket defaultApi() {
ParameterBuilder parameterBuilder = new ParameterBuilder();
List<Parameter> parameters = Lists.newArrayList();
parameterBuilder.name("sign").description("sign令牌").modelRef(new ModelRef("String"))
.parameterType("header")
.required(false).build();
parameters.add(parameterBuilder.build());
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.jinhui.community.modular"))
// .apis(RequestHandlerSelectors.withMethodAnnotation(RestController.class))
.paths(PathSelectors.any())
.build().globalOperationParameters(parameters);
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("XXX后台接口文档")
.description("#XXX RESTful APIs")
.termsOfServiceUrl("www.xxxx.com")
.contact("author")
.version("1.0.0")
.build();
}
}
最后修改于 2021-05-21 15:41:23
如果觉得我的文章对你有用,请随意赞赏
扫一扫支付

