首页 > 其他分享 >springboot2.5.6集成swagger3

springboot2.5.6集成swagger3

时间:2023-02-03 23:00:40浏览次数:54  
标签:集成 springboot2.5 Swagger documentation swagger3 文档 import springfox Docket

  • 引入依赖
    <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

 

  • application.yml配置
spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
  • 启动依赖

  

@EnableOpenApi //开启swagger支持

 

  • swaggerConfig
package com.springboot.test.config.swagger;

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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * @author cf
 * @date 2022/12/3 18:56
 * @description swagger配置类
 */
@Configuration
@EnableOpenApi //开启swagger支持
public class SwaggerConfig {

    /**
     * Docket类是Swagger的配置类,要自定义修改 Swagger 的默认配置信息,我们需要覆盖该对象
     * @return
     */
    @Bean
    public Docket docket(){
        //1.以OAS_30标准构建Docket配置类
        return new Docket(DocumentationType.OAS_30)
                //2.配置Swagger接口文档基本信息apiInfo
                .apiInfo(apiInfo())
                //3.select方法开启配置扫描接口的Builder
                .select()
                //4.指定要扫描/维护接口文档的包(否则就全部扫描)
                .apis(RequestHandlerSelectors.basePackage("com.springboot.test.controller"))
                //5.路径过滤:该Docket-UI展示时,只展示指定路径下的接口文档(any表示都展示)
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 配置 Swagger 接口文档的基本信息
     * @return
     */
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                //1.接口文档标题
                .title("SpringBoot整合Swagger")
                //2.接口文档描述内容
                .description("这里是SpringBoot整合Swagger的详细信息")
                //3.项目文档迭代版本
                .version("9.0")
                //4.主要联系人信息(姓名name,个人主页url,邮箱email)
                .contact(new Contact("cf","www.1111.com","[email protected]"))
                //5.相关许可证信息
                .license("The CSDN License")
                //6.相关许可证链接
                .licenseUrl("www.baidu.com")
                //7.返回构建的ApiInfo对象
                .build();
    }

}
  • 启动地址
http://localhost:8081/swagger-ui/index.html#/

 

标签:集成,springboot2.5,Swagger,documentation,swagger3,文档,import,springfox,Docket
From: https://www.cnblogs.com/gylhaut/p/17090661.html

相关文章

  • GitLab集成PlantUML
    1.前言当在GitLab集成并正确配置PlantUML后,您可以在snip、Wiki和代码库中创建图表。此GitLab.com上PlantUML默认为所有SaaS用户启用,不需要任何额外配置。要在自管理实例......
  • ARMA-EGARCH模型、集成预测算法对SPX实际波动率进行预测|附代码数据
    全文下载链接:http://tecdat.cn/?p=12174我们被要求在本周提供一个报告,该报告将结合ARMA-EGARCH,集成预测算法等数值方法本文比较了几个时间序列模型,以预测SP500指数的每日......
  • 初次使用 WebSocket -springboot 集成
    参考自:SpringBoot集成websocket_清泉影月的博客-CSDN博客,WebSocket中利用service层交互数据库_戒烟的李白的博客-CSDN博客_websocketservice核心依赖<dependency>......
  • vue+springboot集成钉钉扫码登录
    具体接入方式可参考官方介绍:https://open.dingtalk.com/document/orgapp-server/tutorial-obtaining-user-personal-information本文只演示vue+springboot如何实现钉钉扫......
  • 抖音小程序集成支付宝支付
    ​大家好,我是小悟申请开通支付申请开通支付功能时,需要在小程序开发者的后台提交申请,如下图所示,并且提供以下资料:商户名称(公司名称)法人姓名渠道支付的业务场景(暂时只支持......
  • SpringBoot集成webService
    我这里用的cxf框架来搭建webService服务我的SpringBoot版本为2.7.5查看项目springBoot版本的方法:1.写测试类,打印springBoot版本@Testvoidversion(){System.out.pr......
  • Seata客户端集成及AT&TCC事务模式演示
    0.前言简要说下背景,当前使用seata是基于官方1.5.2版本开发的,所以集成过程可供1.5.2及之后版本的使用者参考,为区别于官方版本,内部版本号设置为1.5.2.2。设计demo演示全局事......
  • springboot集成swagger的坑
    1、端口问题无法访问此网站网址为 http://localhost:6666/swagger-ui.html 的网页可能暂时无法连接,或者它已永久性地移动到了新网址。ERR_UNSAFE_PORT 如图:......
  • 四化智造MES(WEB)与金蝶云星空对接集成工件分配查询(委外明细)打通采购申请单新增
    四化智造MES(WEB)与金蝶云星空对接集成工件分配查询(委外明细)打通采购申请单新增数据源系统:四化智造MES(WEB)MES建立统一平台上通过物料防错防错、流程防错、生产统计、异......
  • CI/CD | 大型企业与开发团队如何进行持续集成与持续发布
    Jenkins是当今最流行的持续集成工具之一,企业选择Jenkins,可以从它的灵活性和自动化能力中获益。但除此之外的其他需求呢?企业规模在不断增大,他们如何在不增加管理负担的情况......