spring boot 集成 swagger3及配置方法

 更新时间:2023年05月24日 11:36:39   作者:没毛的刷子  
Swagger 3是一种开源的API描述工具,它可以帮助开发人员设计、构建、文档化和测试API,这篇文章主要介绍了spring boot 集成 swagger3,需要的朋友可以参考下

Swagger 3是一种开源的API描述工具,它可以帮助开发人员设计、构建、文档化和测试API。Swagger 3支持多种编程语言和框架,包括Java、Node.js、Python、Ruby等,并提供了许多集成工具和插件,例如Postman、Apigee等。 Swagger 3使用OpenAPI规范来描述API,这是一种通用的API描述语言,适用于各种编程语言和框架。OpenAPI规范定义了API的基本结构、请求和响应的参数、头部信息、路径、HTTP方法和安全方案等。通过使用Swagger 3,开发人员可以从API文档中快速了解API的特点和功能,有效简化了API的构建维护。 在使用Swagger 3时,您需要在项目中添加Swagger 3依赖项,并配置好Swagger 3配置文件。然后您可以使用注释标记您的API端点以及请求和响应类和字段等,Swagger 3会根据这些注释生成API文档并提供UI界面进行浏览和测试等操作。

引入依赖

注:不需要额外依赖,只需要下面一个就能完成

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

配置文件

​spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

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.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.ArrayList;
/**
 * swagger配置
 */
@Configuration
public class SwaggerConfig {
    Boolean swaggerEnabled = true;
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 是否开启
                .enable(swaggerEnabled)//true
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.***.***")//配置扫描的路径
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("****接口文档")
                .contact(new Contact("clc", "http://www.baidu.com", "clc@x.com"))
                .version("1.0")
                .description("基本的一些接口说明")
                .license("Apache 2.0 许可") // 许可
                .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0") // 许可链接
                .extensions(new ArrayList<>()) // 拓展
                .build();
    }
}

常用注解

Swagger3 常用注解使用位置
@Api在 Java 类上添加该注解。
@ApiOperation在 Java 类的方法上添加该注解。
@ApiParam在 Java 类的方法参数上添加该注解。
@ApiResponses在 Java 类的方法上添加该注解。
@ApiSecurity在 Java 类的方法上添加该注解。
@ApiModel在 Java 类的方法参数或返回值上添加该注解。
@ApiImplicitParams在 Java 类的方法参数上添加该注解。
@ApiHeader在 Java 类的方法参数或返回值上添加该注解。
@ApiFormData在 Java 类的方法参数或返回值上添加该注解。
@ApiUseDefaultValues在 Java 类的方法参数上添加该注解。

请求地址http://localhost:端口/swagger-ui/index.html

到此这篇关于spring boot 集成 swagger3的文章就介绍到这了,更多相关spring boot 集成 swagger3内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 了解java中的session

    了解java中的session

    这篇文章主要介绍了了解java中的session的相关问题,什么是session,session怎么用等,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • Java Servlet 表单数据处理详解

    Java Servlet 表单数据处理详解

    本文详细介绍了Servlet处理表单数据的方法,涵盖配置Servlet、获取参数、数据验证及响应内容设置,深入探讨 Servlet 如何接收、处理和响应表单数据,并提供一些最佳实践,以确保数据处理的正确性和安全性,感兴趣的朋友一起看看吧
    2026-05-05
  • Spring Boot 2.x/3.x/4.x 版本兼容的最新MyBatis-Plus依赖

    Spring Boot 2.x/3.x/4.x 版本兼容的最新MyBatis-Plus依赖

    本文主要介绍了Spring Boot 2.x/3.x/4.x 版本兼容的最新MyBatis-Plus依赖,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2026-03-03
  • Java实现解析dcm医学影像文件并提取文件信息的方法示例

    Java实现解析dcm医学影像文件并提取文件信息的方法示例

    这篇文章主要介绍了Java实现解析dcm医学影像文件并提取文件信息的方法,结合实例形式分析了java基于第三方库文件针对dcm医学影像文件的解析操作相关实现技巧,需要的朋友可以参考下
    2018-04-04
  • MyBatis-Plus 分页查询以及自定义sql分页的实现

    MyBatis-Plus 分页查询以及自定义sql分页的实现

    这篇文章主要介绍了MyBatis-Plus 分页查询以及自定义sql分页的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • SpringBoot配置文件导入方法详细讲解

    SpringBoot配置文件导入方法详细讲解

    Spring Boot虽然是Spring的衍生物, 但默认情况下Boot是不能直接使用Spring的配置文件的, 我们可以通过两种方式导入Spring的配置
    2022-10-10
  • Java实战之敏感词过滤器

    Java实战之敏感词过滤器

    这篇文章主要介绍了Java实战之敏感词过滤器,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • Java servlet执行流程代码实例

    Java servlet执行流程代码实例

    这篇文章主要介绍了Java servlet执行流程代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • SpringBoot多模块项目中优雅实现自动配置的完整指南

    SpringBoot多模块项目中优雅实现自动配置的完整指南

    在 Spring Boot 开发中,自动配置 是一个绕不开的核心能力,本文将结合一个 RabbitService 自动配置的示例,完整讲解如何在 Spring Boot 多模块项目中实现自动配置,希望对大家有所帮助
    2026-02-02
  • Java分页查询的几种实现方法举例

    Java分页查询的几种实现方法举例

    这篇文章主要给大家介绍了关于Java分页查询的几种实现方法,分页是系统中常用到的功能,只要涉及到查询必定伴随而来的就是分页,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-06-06

最新评论