SpringBoot生成RESTful API文档

10月前作者：超* 分类：Toy博客阅读(54) 违法举报

这篇具有很好参考价值的文章主要介绍了SpringBoot生成RESTful API文档。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

由于我一开始学习的SpringBoot是3以上版本，所以我这里用到的也是支持和SpringBoot3能够整合的SpringDoc

这里先说一下，其实SpringDoc就是Swagger3版本，我一开始整合的2版本，比较麻烦况且最后SpringBoot程序都启动不了了，后面查资料才看到SpringDoc，好使的一批！！
官网地址：http://springdoc.org

一、依赖配置

在上篇文章中用到的项目模块基础上进行！

SpringBoot生成RESTful API文档

在pom.xml中添加该依赖，按照官网提供的最新版本

SpringBoot生成RESTful API文档

接下来执行入口文件，就可以在浏览器通过swagger-ui.html访问该页面了

二、基础配置

SpringBoot生成RESTful API文档

再去浏览器查看就能看到修改的内容了

SpringBoot生成RESTful API文档

三、常用注解

@Tag	描述整个Controller
@Operation	描述具体接口信息
@Parameter	描述参数信息
@ApiResponse	接口相应描述信息
@Schema	描述对象以属性信息

四、练习

1、新建实体类

SpringBoot生成RESTful API文档

2、编写Controlle

SpringBoot生成RESTful API文档

3、查看

SpringBoot生成RESTful API文档

五、总结

更多配置操作，可以去官网查看！有了SpringDoc就可以很好的自动生成和展示API文档了！

这样前后端分离就有已经有了雏形了，到时候再整合Mybatis就可以生成一个完整的API文档，就可以和前端分工明确了文章来源地址https://www.toymoban.com/news/detail-475561.html

到了这里，关于SpringBoot生成RESTful API文档的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：如若内容造成侵权/违法违规/事实不符，请点击违法举报进行投诉反馈，一经查实，立即删除！

分享到：

领支付宝红包赞助服务器费用

SpringBoot定义优雅全局统一Restful API 响应框架六

闲话不多说，继续优化全局统一Restful API 响应框架做到项目通用接口可扩展。如果没有看前面几篇文章请先看前面几篇 SpringBoot定义优雅全局统一Restful API 响应框架 SpringBoot定义优雅全局统一Restful API 响应框架二 SpringBoot定义优雅全局统一Restful API 响应框架三 SpringBoot定义优

2024年02月08日
浏览(39)
SpringBoot定义优雅全局统一Restful API 响应框架五

闲话不多说，继续优化全局统一Restful API 响应框架做到项目通用接口可扩展。如果没有看前面几篇文章请先看前面几篇 SpringBoot定义优雅全局统一Restful API 响应框架 SpringBoot定义优雅全局统一Restful API 响应框架二 SpringBoot定义优雅全局统一Restful API 响应框架三 SpringBoot定义优

2024年02月07日
浏览(37)
无需编程，基于微软mssql数据库零代码生成CRUD增删改查RESTful API接口

通过之前一篇文章无需编程，基于甲骨文oracle数据库零代码生成CRUD增删改查RESTful API接口的介绍，引入了FreeMarker模版引擎，通过配置模版实现创建和修改物理表结构SQL语句，并且通过配置oracle数据库SQL模版，基于oracle数据库，零代码实现crud增删改查。本文采用同样的方式，

2024年02月05日
浏览(45)
【Java可执行命令】（三）API文档生成工具javadoc：深入解析Java API文档生成工具javadoc ~

javadoc 是Java的一个可执行命令程序，它旨在为Java源代码生成API文档。它由Sun Microsystems（现为Oracle Corporation）于1995年引入，是Java开发工具包（JDK）的一部分。 javadoc 是通过分析源代码中的注释来生成API文档的工具。在编写Java代码时，开发人员可以使用特殊的注释标签来描述

2024年02月16日
浏览(42)
API文档生成(sphinx)

1.安装 pip install Sphinx 2.使用 2.1文档手册 Sphinx 1.3.1 中文手册 (推荐查看)教程https://fengxc.me/基于python注释使用sphinx自动化生成API文档.html 2.2创建工程新建一个文件夹sphinx_test, 并创建两个子文件夹code, doc。目录结构如下：进去到doc目录，打开powershell, 执行下边命令创建工程 s

2024年01月23日
浏览(38)
Forest-声明式HTTP客户端框架-集成到SpringBoot实现调用第三方restful api并实现接口数据转换

声明式HTTP客户端API框架，让Java发送HTTP/HTTPS请求不再难。它比OkHttp和HttpClient更高层，是封装调用第三方restful api client接口的好帮手，是retrofit和feign之外另一个选择。通过在接口上声明注解的方式配置HTTP请求接口。官网: Forest 代码地址: forest: 声明式HTTP客户端API框架，让

2024年02月04日
浏览(115)
全网最详细中英文ChatGPT-API文档（一）开始使用ChatGPT——导言

The OpenAI API can be applied to virtually any task that involves understanding or generating natural language or code. We offer a spectrum of models with different levels of power suitable for different tasks, as well as the ability to fine-tune your own custom models. These models can be used for everything from content generation to semantic search and cl

2023年04月25日
浏览(50)
Apikit 自学日记:自动生成 API 文档

功能入口：API管理应用 / 选中某个项目 / 其他菜单 / 数据源同步（API文档自动生成）该功能可通过配置数据源信息，实现基于数据源的API信息自动生成API文档。当前支持5种数据源： Swagger URL、apiDoc、Github、gitlab、码云。 Swagger URL和apiDoc的数据源配置方式一致，仅需填写来

2024年02月11日
浏览(52)
SpringBoot使用Swagger配置API接口文档

Swagger是一个用于设计、构建和文档化 RESTful API 的开源框架。它提供了一组工具，使得开发人员能够更轻松地定义、描述和测试API接口。具体来说，Swagger包含以下几个核心组件： Swagger规范（Swagger Specification）: 定义了一种格式化的API规范，使用YAML或JSON格式，用于描述API的各

2024年02月05日
浏览(48)
springboot生成接口文档

当我们在使用Spring MVC写接口的时候，为了生成API文档，为了方便整合Swagger，都是用这个SpringFox的这套封装。但是，自从2.9.2版本更新之后，就一直没有什么动静，也没有更上Spring Boot的大潮流，有一段时间还一直都是写个配置类来为项目添加文档配置的。为此，之前就造了这

2024年02月03日
浏览(35)