这篇文章将带你了解如何用spring官方推荐的restdoc去生成api文档。本文创建一个简单的springboot工程,将http接口通过Api文档暴露出来。只需要通过 JUnit单元测试和Spring的MockMVC就可以生成文档。
准备工作
- 你需要15min
- Jdk 1.8
- maven 3.0+
- idea
创建工程
引入依赖,其pom文件:
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.restdocs</groupId> <artifactId>spring-restdocs-mockmvc</artifactId> <scope>test</scope> </dependency> </dependencies>
免责声明:
① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。
② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341
软考中级精品资料免费领
- 历年真题答案解析
- 备考技巧名师总结
- 高频考点精准押题
- 资料下载
- 历年真题
193.9 KB下载数265
191.63 KB下载数245
143.91 KB下载数1148
183.71 KB下载数642
644.84 KB下载数2756
相关文章
发现更多好内容- 在 Java 中,究竟什么是线程安全?(java中什么是线程安全)
- Java 中 toString 方法该如何使用呢?(java中tostring方法如何使用)
- JavaScript函数式编程有哪些实用技巧?(JavaScript函数式编程有啥技巧)
- Java 中 random 函数的异常处理机制究竟是什么?(java random函数的异常处理机制是什么)
- Java 下载文件时怎样验证文件完整性?(java下载文件时如何验证文件完整性)
- 如何在 Java 中统计数组元素出现的次数?(java如何统计数组元素出现次数)
- Java 中属性和变量的区别究竟有哪些?(java属性和变量的区别有哪些)
- 深入解析:Redis客户端与其他常用工具的比较
- 如何确保 JavaScript DOM 操作的兼容性?(JavaScript DOM操作如何保证兼容性)
- 如何在 Java 中抛出和捕获异常?(java怎么抛出和捕获异常)
猜你喜欢
AI推送时光机详解如何用spring Restdocs创建API文档
后端开发2023-05-31
如何用spring Restdocs创建API文档
后端开发2023-06-19
SpringBoot如何自动生成API文档详解
后端开发2024-04-02
win7无法创建word文档如何解决
后端开发2023-06-28
PHP 函数文档最佳实践:如何创建清晰且有用的文档
后端开发2024-04-11
SpringBoot详细讲解如何创建及刷新Spring容器bean
后端开发2024-04-02
Ubuntu下如何创建XFS文件系统的LVM详解
后端开发2022-06-04
一文详解如何创建自己的Python装饰器
后端开发2024-04-02
Linux中如何查看文件的创建时间详解
后端开发2022-06-04
Java如何使用spire进行word文档的替换详解
后端开发2023-01-09
详解如何使用openssl创建自签名证书
后端开发2023-05-17
如何利用SQL语句创建数据库详解
后端开发2022-06-16
详解Java如何利用位操作符创建位掩码
后端开发2022-11-13
如何使用Java API创建和编辑文件以及通过IDE进行调试?
后端开发2023-10-12
咦!没有更多了?去看看其它编程学习网 内容吧