SpringBoot集成swagger、yapi

最新推荐文章于 2025-01-26 11:49:21 发布

Tracyclock

最新推荐文章于 2025-01-26 11:49:21 发布

阅读量4.9k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： java

本文链接：https://blog.youkuaiyun.com/Tracyclock/article/details/99673380

本文详细介绍了如何在SpringBoot项目中集成swagger进行API文档管理，并进一步结合yapi进行测试环境的搭建。首先，通过引入pom依赖、配置swagger及编写相关注解来实现API的展示。然后，通过yapi的导入功能将swagger数据转化为yapi接口文档，方便团队协作和测试。同时提供了主要注解的使用说明和参考资料链接。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、如何使用

第一步，引入pom文件

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!--swagger增强UI-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.5</version>
        </dependency>

第二步，编写swagger配置类

package com.tracy.swagger.config;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
import javax.xml.ws.Response;
import java.util.ArrayList;
import java.util.List;

/**
 * @EnableSwaggerBootstrapUI   swagger页面优化 使用时账密验证
 * @EnableSwagger2  开启swagger
 * swagger.enable 项目动态启用swagger
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        //可以通过此方式添加全局header
        ParameterBuilder parameterBuilder = new ParameterBuilder();
        List