Swagger的使用

本文介绍如何使用Swagger自动生成RESTful Web服务的接口文档。包括Swagger2与SpringBoot项目的集成步骤,从添加依赖到实现RESTFul服务并进行接口测试的全过程。

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

1.什么是Swagger?

       Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。简而言之Swagger是一款能够帮助我们自动生成接口文档工具;

2.怎么用

********详细介绍Spring Boot 2.0 集成 Swagger2流程

第一步,新建工程,在POM中添加Swagger2依赖,如图

第二步,编写启动类 

第三步,至此,Swagger2可以与Spring Boot项目一起工作了。运行项目,在浏览器中访问URL(localhost:8080/v2/api-docs),验证效果如下图所示:

 

第四步,问题接踵而至。第三步访问URL运行结果是一堆JSON串,非常生涩难懂,不具有人性化。庆幸的是,Swagger2提供了UI交互的解决方案,在POM中添加Swagger2 UI依赖。如下图:

 

第五步,运行项目,在浏览器中访问URL(localhost:8080/swagger-ui.html),验证效果如下图所示:

运行结果

第六步,新建SwaggerController类,提供RESTFul服务

第七步,运行项目,在浏览器中访问URL(localhost:/swagger-ui.html),点击“Try it out!”按钮,可以进行服务接口测试。验证效果。

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值