SpringBoot集成knife4j生成swagger文档

最新推荐文章于 2024-06-28 22:20:44 发布

林生石竹

最新推荐文章于 2024-06-28 22:20:44 发布

阅读量190

点赞数

分类专栏： SpringBoot 文章标签： spring boot swagger2

本文链接：https://blog.csdn.net/RO_YI/article/details/116163878

版权

SpringBoot 专栏收录该内容

5 篇文章 1 订阅

订阅专栏

文章目录

一、引入依赖
二、配置

一、引入依赖

<dependency>
  <groupId>com.github.xiaoymin</groupId>
   <artifactId>knife4j-spring-boot-starter</artifactId>
   <version>3.0.2</version>
</dependency>

二、配置

package com.sofia.sofro.config;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author sofia
 */
@Slf4j
@Configuration
public class Swagger2Config{

	/**
	 * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
	 *
	 * @return Docket
	 */
	@Bean
	public Docket defaultApi2() {
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(new ApiInfoBuilder()
						// 大标题
						.title("Sofro后台服务API接口文档")
						// 版本号
						.version("1.0")
						// 描述
						.description("后台API接口")
						// 作者
						.contact(new Contact("Sofia", "", ""))
						.build())
				.pathMapping("/")
				.select()
				//此包路径下的类，才生成接口文档
				.apis(RequestHandlerSelectors.basePackage("com.sofia.sofro.modules"))
				.paths(PathSelectors.any())
				.build();
	}
}

knife4j:
  # 开启增强配置
  enable: true
  # 开启生产环境屏蔽
  production: false
  # basic验证
  basic:
    # 是否开启
    enable: true
    # 用户名
    username: admin
    # 密码
    password: 123456