Spring Boot 集成 Swagger

Spring Boot-集成Swagger 再通过Swagger衍生出来的一系列项目和工具,就可以做到生成各种格式的接口文档,生成多种语言的客户端和服务端的代码,以及。 阅读详情

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。在 Spring Boot 中可以通过集成 Swagger 的方式完成文档的自动生成并保持完整的一致性,集成步骤如下:

  1. 添加 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>
  1. 启用 Swagger 文档配置
@Configuration
@EnableSwagger2
@WebContext
public class SwaggerConfig {

    @Bean
    public Docket petApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2);
        
        // 配置文档基本描述信息
        docket.apiInfo(apiInfo());
        // 配置全局参数
        docket.globalOperationParameters(buildGlobalOperationParameters());
        
        // 配置文档接口描述:
        // 1. 接口扫描基本包范围
        // 2. 接口统一前缀
        docket.select()
                .apis(RequestHandlerSelectors.basePackage("pwc.taxtech"))
                .paths(PathSelectors.regex("/api/.*"))
                .build();
                
        return docket;
    }

    private List<Parameter> buildGlobalOperationParameters() {
        List<Parameter> parameterList = new ArrayList<Parameter>();
        
        // 此处配置了公用的授权参数位于请求头中
        ParameterBuilder parameterBuilder = new ParameterBuilder();
        parameterBuilder.name("Authorization").description("Bearer [JWT token]").modelRef(new ModelRef("string"))
                .parameterType("header").required(false).build();
        parameterList.add(parameterBuilder.build());
        
        return parameterList;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("文档标题")
                .description("文档描述")
                .version("文档版本")
                .build();
    }
}
  1. 描述接口信息

可以通过 @Api, @ApiOperation, @ApiParam 等一系列的注解描述接口和参数信息,使得文档更具有可读性,更多的相关注解请查看官方文档。

@Api("用户接口")
@RestController
@RequestMapping("/user")
public class UserController {
    
    @ApiOperation(value = "接口名称", notes = "接口详细描述")
    @GetMapping("/{id}")
    public User getUser(@ApiParam("用户 ID") @PathVariable String id) {
        User user = new User();
        // ...
        return user;
    }
}
Spring Boot 3项目集成Swagger3教程 欢迎来到我的小天地,这里是我记录技术点滴、分享学习心得的地方。??让我们一起在技术的道路上不断前行!?? 阅读详情

相关推荐

Spring Boot项目集成Swagger

一、Swagger——API文档工具 1、Swagger官网地址:https://swagger.io/     Swagger是一款RestFul风格的API文档在线生成工具,用于API文档的定义与同步更新,可以直接运行,直接在线测试API接口,而且支持多种语言。 2、在项目中使用Swagger需要导入jar包:springfox-swagger2和springfox-swagger-ui Maven中央仓库查询地址:https://mvnrepository.co

NJ_Nakia的博客 345

SpringBoot + SpringSecurity+JWT整合(微服务适用)

SpringSecurity基于表单的登录认证流程如下图: 大致过程是在UsernamePasswordAuthenticationFilter将username和password封装成UsernamePasswordAuthenticationToken,之后会在AuthenticationProvider(接口,需要自己实现)的authenticate方法中拿到且校验(一般是查数据库,对比账号密码),而校验成功则返回Authentication接口对象(一般情况是直接返回UsernamePassw

weixin_42372860的博客 1514

SpringBoot系列:Spring Boot集成Swagger2

Swagger2 Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 随着前后端分离越来越流行,但同时前后端开发的成本也增加了,撰写和维护接口文档会耗费开发人员很大一部分精力,而Swagger的出现恰好解决了这个问题,极大的提升了团队开发的沟通效率,同时也方便开发人员进行接口开发自测。 Spring Boot集成Swagger2 首先...

Simple_Yangger的博客 9048

swagger-03-文档注释使用

swagger-03-文档注释使用

时光 4017

Spring Boot 集成 Swagger UI

作者:禅与计算机程序设计艺术Swagger(也被称作OpenAPI Specification)是一个开放源代码的项目,用于定义、描述、产生、消费RESTful API,目前已成为事实上的标准。其主要功能包括:Swagger是一个开源的API开发规范,提供了一系列工具,能够帮助设计人员、工程师快速编写清晰的API文档,从而方便其他开发者调用API。Spring Boot是一个由Pivotal团队提供的新型开源框架,其旨在帮助开发人员快速搭建单体或微服务架构中的应用。它简化了配置,通过自动装配组件和服务,降低

AI天才研究院 2076

Swagger UI及其集成到Spring Boot应用中

Swagger 是一款开源、功能丰富的 API 概述文档工具。它能够帮助我们快速、清晰地定义、结构化和展示我们的 API,同时也支持多种开发语言,如 Java、JavaScript、Python等。在 Spring Boot 中,使用 Swagger 可以极大方便 API 的测试、调试以及提供给其他团队进行交流学习。本文将会用简单的方式对 Spring Boot 和 Swagger 有个整体的认识,并通过一个实际案例——集成 Spring Boot 项目中 Swagger UI 来展现它的优点。

AI天才研究院 2794

swagger使用

1.添加pom依赖 <!--swagger--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> ...

u012877396的博客 383

基于单目视觉的四旋翼定点降落——如何通过mavros控制pixhawk(二)

    一直拖了这么久没有更新,怪我太懒啦~~~ 今天要特别感谢舒仔仔同学,我的好队友帮我写了这篇博文。这篇文章主要讲了如何通过mavros来控制pixhawk。硬件逻辑是这样子,我们先搞一个odroid(土豪上TX2),再用usb线将odroid与pixhawk连接。所以,odroid发送控制指令来控制pixhawk飞行。pixhawk与外界的通信协议是mavlink。ROS下面有个包叫mavr...

zhengyuxin0507的博客 1万+

07SpringBoot集成Swagger

Swagger简介: 前后端分离问题的出现造就了Swagger的出现,问题就是:前后端的集成,前端或者后端无法做到及时协商,尽早解决,最终会导致问题集中的爆发。Swagger的出现实时跟踪了最新的API,降低集成风险。 优点 号称世界上最流行的API框架 Restful API文档自动生成器==>API文档与API定义同步更新 直接运行,在线测试API 支持多种语言,如:JAVA PHP等 官网:https://swagger.io/ SpringBoot集成Swagger 要求:jdk1.8+否

niannujiao6的博客 309

HMC7044芯片模拟SPI配置

摘要: HMC7044是一款高性能双环路整数N分频抖动衰减器,支持SPI接口配置,适用于高速数据转换器时钟系统。该芯片采用双PLL级联架构,具有14路可配置输出,可满足GSM/LTE基站设计需求。SPI接口采用3线模式(SLEN/SCLK/SDATA),支持24位寄存器读写(13位地址+8位数据)。驱动实现基于Zynq EMIO模拟SPI,提供初始化、数据传输及寄存器配置功能,支持三线制工作模式和多种时钟参数设置。

toonyhe的博客 1099

统信UOS开发环境支持Java

集成了JDK和多种IDE,为开发者提供了从代码编写、编译、调试到部署的一站式开发解决方案。

RZer的博客 2256

swagger的接口自定义排序和接口中参数自定义排序

接口自定义排序 package com.hfvast.east_olympic.config; import io.swagger.models.parameters.Parameter; import org.springframework.context.annotation.Primary; import org.springframework.core.Ordered; import org.springframework.core.annotation.Order; import org.sp

蓝色的猴子 8842

【100%通过率】2023华为od机试C卷【电脑病毒感染】C++ 实现

一个局域网内有很多台电脑,分别标注为 0 ~ N-1 的数字。相连接的电脑距离不一样,所以感染时间不一样,感染时间用t 表示。其中网络内一台电脑被病毒感染,求其感染网络内所有的电脑最少需要多长时间。如果最后有电脑不会感染,则返回-1.

MISAYAONE的博客 1728

JAVA开发 在 Spring Boot 中集成 Swagger

添加和依赖。创建配置类启用 Swagger。添加依赖。不需要额外的配置类,会自动配置 Swagger。通过以上步骤,你可以在 Spring Boot 项目中成功集成 Swagger,并生成和查看 API 文档。

weixin_64401027的博客 1548

Halcon算子知识:optical_flow_mg

光流(Optical Flow)是一种研究图像对齐的算法,一般包括两大类:稀疏光流和稠密光流。稀疏光流就是研究图像中稀疏点的光流,这些点一般是角点;稠密光流则是研究图像中所有点的偏移量。以下介绍halcon的基本光流算子optical_flow_mg的原理方法。该算子计算两个图片的光流法。 二、算子说明 optical_flow_mg(ImageT1, ImageT2 : VectorField : Algorithm, SmoothingSigma, Integration

gongdiwudu的专栏 1万+

无需qt-creator,使用Trae从0到1生成qt的开发、构建、调试环境

没有使用qt creator,也没有在trae中安装qt相关的插件,我也没有写一行代码,纯粹聊天使用trae开发出了一个qt程序

cpp加油站的专栏 2950

Swagger基本知识及Spring Boot集成指南

Swagger在Spring Boot中的集成与应用 Swagger是一套基于OpenAPI规范的开源工具集,用于RESTful API的设计、文档化和测试。主要优势包括自动生成交互式文档、减少开发沟通成本、支持前后端分离协作。Spring Boot项目可通过Springfox或springdoc-openapi集成Swagger,具体步骤包括添加依赖、配置Docket/OpenAPI Bean、使用注解描述API(如@Api、@ApiOperation等)。Swagger提供可视化UI界面,支持API分组

随便写写 2386

SAP HANA CDS View Syntax Options 全解:从语法到工程实践

本文面向SAP HANA工程师,深入解析CDS视图的语法与应用场景。文章涵盖XS Advanced环境下的CDS视图设计要点,包括SELECT基础语法、聚合函数与分组约束、参数化视图实现以及常见连接操作。特别强调工程实践中的注意事项:GROUP BY禁用表达式、原生表名大小写规范、结果集裁剪方式选择等。通过两个真实案例(办公室占用率统计和客户画像分析)展示CDS视图在实际业务中的应用,并提供性能优化建议。全文采用中英文混排规范,技术术语使用反引号标注,旨在为开发者提供清晰的CDS视图开发指南。

2007 年 ~ 2025 年,深耕 SAP 技术 18 年 217

Spring Boot 集成Swagger

http://www.apache.org/licenses/LICENSE-2.0.html”//网站链接。“http://www.apache.org/licenses/LICENSE-2.0.html”//网站链接。(Ajax Post Data:{“name”:“名称”,“content”:“内容”})(Ajax Post Data:{“name”:“名称”,“content”:“内容”}).paths(or(regex(“/demo/.*”)))//过滤的接口。

2501_90392025的博客 1678

【AI测试干货】软件测试 - 全流程提示词完整体系

本篇教程是一套专为软件测试工程师打造的 AI 协作提示词体系。从测试计划制定、用例设计、自动化脚本开发、缺陷管理,到测试报告生成,每个环节都提供了结构化的提示词模板,帮助测试人员高效利用 AI 提升工作质量。

blues_C的博客 357

迈瑞BS系列全自动生化分析仪LIS协议接口手册(内含HL7和ASTM)

迈瑞BS系列全自动生化分析仪LIS协议接口手册,内含HL7和ASTM)

Spring Boot 集成 Knife4j 的 Swagger 文档

在开发微服务应用时,API 文档的生成和维护是非常重要的一环。Swagger 是一个非常流行的 API 文档工具,可以帮助我们自动生成 RESTful API 的文档,并提供了一个友好的界面供开发者测试 API。本文将介绍如何在 Spring Boot 项目中集成 Knf4j 的 Swagger,以实现 API 文档的自动生成和展示。

kersixy的博客 1691

温度PID控制PLC程序

温度PID稳定控制程序,适用于欧姆龙PLC,对其他PLC也具有很大参考价值

Java Spring Boot项目中集成Swagger完整步骤

SpringBoot集成Swagger生成API文档的两种方案:1)Springfox方案(适合SpringBoot2.x):添加springfox-swagger2和springfox-swagger-ui依赖,配置SwaggerConfig类,通过/swagger-ui.html访问;2)SpringDoc方案(推荐SpringBoot3.x):改用springdoc-openapi依赖,通过/swagger-ui/index.html访问。两种方式都支持自动生成RESTful接口文档,提供在线测试功能

LeungChunwai的博客 1105

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

廖雪峰Python教程[完整版]

廖雪峰的python教程整理的,已经排好版了,而且还是完整的,适合小白

Spring boot集成Swagger,并配置多个扫描路径

springBoot集成swagger 1、引入pom 2、配置swagger 在Application.java同级或子包中创建SwaggerConfig.java package com.example.demo.swagger; import org.springframework.context.annotation.Bean; import springfox.documentatio...

Ccccyxji的博客 7096
上一篇: Spring 中的拦截机制
KeanePeng
博客等级 码龄10年 0粉丝 5原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值