springboot集成Knife4j(swagger)

最新推荐文章于 2024-09-26 00:43:00 发布

执迷11

最新推荐文章于 2024-09-26 00:43:00 发布

阅读量3.6k

点赞数

本文链接：https://blog.csdn.net/weixin_46666822/article/details/127766317

版权

springboot 专栏收录该内容

16 篇文章 1 订阅

订阅专栏

本文档介绍了如何通过引入Knife4j依赖，在Spring Boot项目中配置Swagger2，创建配置类，设置API信息，并在接口上添加注解来生成接口文档。启动项目后，可以通过访问/doc.html查看生成的文档效果。

摘要由CSDN通过智能技术生成

官网：https://doc.xiaominfo.com/

1.pom

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

2.创建配置类

@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {
    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("mygulimall 接口文档")
                        .description("# 我的商城项目接口文档")
                        .termsOfServiceUrl("http://www.baidu.com/")
                        .contact("xx@qq.com")
                        .version("1.0")
                        .build())
                //分组名称
                .groupName("商品系统")
                .select()
                //这里指定Controller扫描包路径
                .apis(RequestHandlerSelectors.basePackage("com.lzp.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

3.配置文件

#用户名密码
knife4j.basic.username=admin
knife4j.basic.password=admin
knife4j.basic.enable=true
#是否为生产模式 项目部属时为true 防止接口暴露
knife4j.production=true
#开启Knife4j增强模式
knife4j.enable=true