『博客开发日记』之使用Swagger生成接口api文档

使用Swagger生成接口api文档

---

关于Swagger

Swagger 是一套基于 OpenAPI 规范构建的开源工具

可以帮助我们设计、构建、记录以及使用 RestAPI

具体实现

先添加依赖

---

在启动类中添加注解

---

在所有接口上添加对应的接口描述注解

---

对于一些接口有多个参数的使用特殊注解

---

对于一些接口需要dto的

---

在所有dto实体类中添加想要接口文档注解

---

因为 VO 类专门用于返回数据，所以也要添加api文档注解，方便返回前端使用

---

通过访问：http://localhost:1314/swagger-ui.html 注意其中localhost和1314要调整成你实际项目的域名和端口号

---

---

PS:该系列只做为作者学习开发项目做的笔记用

不一定符合读者来学习，仅供参考

---

预告

后续会记录博客的开发过程

每次学习会做一份笔记来进行发表

“一花一世界，一叶一菩提”

---

版权所有 © 2025 云梦泽
欢迎访问我的个人网站：https://hgt12.github.io/