基于若依框架实践（三）：通过swagger定义接口

相关文章：

基于若依框架实践（一）：总体的介绍_疯癫的老码农的博客-优快云博客

基于若依框架实践（二）：通过profile隔离不同环境配置_疯癫的老码农的博客-优快云博客

写作背景

做了很多年的软件研发，写的文章不多、总结的也不多，曾经做过的积累或者后续的遇到的技术难点还是考虑稍微写一写，算是给自己的一个记录吧~。

近期基于若依框架开发了好几个小系统, 系统从功能上既包含管理台功能也有自己的前台部分，借此机会做一个总结，并且分享给有需要的同学,不喜勿喷，有劳各位看官费神了。

本文简介

在 SpringBoot 中，我们可以通过 swagger框架来定义接口。当前软件应用开发中，很多情况下采用了前后端分离开发的模式，为提升协同效率必然提前把接口协议先定义好，然后分头去开发。本文是基于若依框架中实践了swagger的使用，以及总结了应用过程中遇到的问题和如何解决这些问题的。

框架优势

在 SpringBoot 项目中使用 Swagger，具有以下优势和价值：

提高团队开发效率：Swagger 是一个 API 文档在线自动生成工具，可以为团队成员提供清晰的 API 文档，方便团队成员了解 API 的使用方法，从而提高团队的开发效率。

降低沟通成本：清晰的 API 文档可以帮助团队成员更好地理解 API 的功能和使用方法，降低团队成员之间的沟通成本。

自动生成文档：Swagger 可以自动生成 API 文档，省去了手动编写文档的过程，减轻了开发人员的负担。

实时更新文档：Swagger 可以实时更新文档，当 API 发生变化时，可以立即在文档中看到变化，保证了文档的准确性。

方便测试：Swagger 可以生成 API 测试报告，方便开发人员进行 API 测试，提高测试效率。

实践总结

下面通过具体场景来表达清晰，我如何进行swagger实践的，请耐心阅读~

1、增加工程依赖

增加如下两个工程

ruoyi-business：里面包含业务功能实现，包括对swagger框架的依赖

ruoyi-swagger：定义测试swagger的接口样例

如下图所示：