swagger的使用+knife4j美化

最新推荐文章于 2024-08-30 05:16:25 发布

weixin_43795761

最新推荐文章于 2024-08-30 05:16:25 发布

阅读量611

点赞数 2

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/weixin_43795761/article/details/108949200

版权

java 专栏收录该内容

17 篇文章 0 订阅

订阅专栏

本文介绍了如何在Spring Boot应用中整合Swagger进行API文档生成，并通过Knife4j进行美化，包括添加依赖、配置Swagger并展示自定义UI。从基础配置到美化细节，适合开发者快速搭建完善的API文档平台。

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

1.添加依赖

<!--swagger-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

2.在启动类中添加@EnableSwagger2注解
在这里插入图片描述

3.在类中添加@Api注解，在方法前添加@ApiOperation注解
在这里插入图片描述
4.输入http://localhost:8080/swagger-ui.html访问即可

美化：
1.加入依赖

<!--swagger美化-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <!--在引用时请在maven中央仓库搜索最新版本号-->
            <version>2.0.4</version>
        </dependency>

2.添加配置类

package com.example.config;

import net.sf.jsqlparser.expression.operators.arithmetic.Concat;
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.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author xxx
 */
@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //这里一定要标注你控制器的位置
//                修改
                .apis(RequestHandlerSelectors.basePackage("com.example.system.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxx管理系统API文档")
                .description("xxx系统API文档")
                .termsOfServiceUrl("https://xxx.gitee")
                .contact(new Contact("xxx","https://xxx.gitee","xxx@qq.com"))
                .version("1.0")
                .build();
    }
}

3.访问地址：http://localhost:8080/doc.html
在这里插入图片描述