首页 > 其他分享 >springboot 接入 swagger 3.0

springboot 接入 swagger 3.0

时间:2024-12-18 09:56:24浏览次数:3  
标签:swagger return springboot documentation 3.0 import springfox class

1. 引入依赖

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

2. application配置

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

3. SwaggerConfig 配置 

import com.fasterxml.classmate.TypeResolver;
import org.springframework.beans.factory.annotation.Autowired;
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;
import java.math.BigDecimal;

@Configuration
@EnableOpenApi
public class SwaggerConfig {

    @Autowired
    private TypeResolver typeResolver;
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket desertsApi2() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo("Swagger3.0", "1.0"))
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.auo.controller"))
                .paths(PathSelectors.any())
                .build()
                .directModelSubstitute(BigDecimal.class, String.class)
//                .additionalModels(typeResolver.resolve(XXXModule.class), typeResolver.resolve(XXXModule.class), ...) //这里将'YourEntity'类加入swagger文档中
                .groupName("api信息")
                .enable(true);
    }
 
    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://ip:port/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
        return new ApiInfoBuilder()
                .title(title)
                .description("api信息")
                .contact(new Contact("GMS", "", ""))
                .termsOfServiceUrl("")
                .version(version)
                .build();
    }
}

4.可通过application.yml中的配置,动态开关swagger

springfox:
  documentation:
    enabled: true

  

 

标签:swagger,return,springboot,documentation,3.0,import,springfox,class
From: https://www.cnblogs.com/uoky/p/18613981

相关文章

  • Java基于springboot+vue的抗洪救灾管理系统
    收藏关注不迷路!!......
  • Java基于springboot+vue的打印店预约及取件系统
    收藏关注不迷路!!......
  • Java基于springboot+vue的扶贫惠农推介系统
    收藏关注不迷路!!......
  • 基于SpringBoot的疫苗在线预约功能实现十三
    一、前言介绍:1.1项目摘要随着全球公共卫生事件的频发,如新冠疫情的爆发,疫苗成为了预防和控制传染病的重要手段。传统的疫苗预约方式,如人工挂号或电话预约,存在效率低、易出错、手续繁琐等问题,无法满足大规模疫苗接种的需求。因此,开发一个高效、便捷的疫苗预约系统显得尤为......
  • 基于SpringBoot的疫苗在线预约功能实现十四
    一、前言介绍:1.1项目摘要随着全球公共卫生事件的频发,如新冠疫情的爆发,疫苗成为了预防和控制传染病的重要手段。传统的疫苗预约方式,如人工挂号或电话预约,存在效率低、易出错、手续繁琐等问题,无法满足大规模疫苗接种的需求。因此,开发一个高效、便捷的疫苗预约系统显得尤为......
  • springboot毕设校园二手交易平台论文+程序+部署
    本系统(程序+源码)带文档lw万字以上 文末可获取一份本项目的java源码和数据库参考。系统程序文件列表开题报告内容一、研究背景随着消费水平的提升以及消费观念的转变,大学生群体中产生了大量的闲置物品。大学生容易受到潮流影响,消费需求较为旺盛,但经济未完全独立,资金主要来......
  • springboot毕设失踪人口寻找互助信息系统论文+程序+部署
    本系统(程序+源码)带文档lw万字以上 文末可获取一份本项目的java源码和数据库参考。系统程序文件列表开题报告内容一、研究背景在现代社会,人口失踪事件频繁发生,这一现象给无数家庭带来了巨大的痛苦与困扰。失踪人口的家属往往陷入极度的焦虑、无助和绝望之中,他们在寻找亲人......
  • SpringBoot如何实现缓存预热?
    在SpringBoot项目中实现缓存预热,主要有以下几种常用方案:1.使用启动监听事件实现缓存预热可以通过实现ApplicationListener接口来监听应用上下文初始化完成的事件,如ContextRefreshedEvent或ApplicationReadyEvent,在这些事件触发后执行数据加载到缓存的操作。例如:@Compone......
  • 毕业设计-基于Java+SpringBoot+Vue宠物领养系统(源码+数据库+项目说明)
    博主介绍:本人专注于java/前端/数据库/微信小程序技术领域的开发,以及多年的计算机毕业设计方面的实战开发经验和技术积累;本人也是多年的全栈开发人员;希望我发布的此篇文件可以帮助到您......
  • 毕业设计-基于Java+SpringBoot+Vue学生成绩管理系统(源码+数据库+论文+PPT+项目说明)
     博主介绍:本人专注于java/前端/数据库/微信小程序技术领域的开发,以及多年的计算机毕业设计方面的实战开发经验和技术积累;本人也是多年的全栈开发人员;希望我发布的此篇文件可以帮助到您......