Spring系列学习之Spring REST Docs
英文原文:https://spring.io/projects/spring-restdocs
目录
概述
Spring REST Docs可帮助您记录RESTful服务。
它结合了使用Asciidoctor编写的手写文档和使用Spring MVC Test生成的自动生成的片段。 这种方法使您免受Swagger等工具生成的文档的限制。
它可以帮助您生成准确,简洁和结构良好的文档。 然后,该文档允许您的用户轻松获取所需信息。
Spring Boot配置
Spring Boot提供@AutoConfigureRestDocs注释,以便在测试中利用Spring REST Docs。
快速开始
使用Spring Initializr引导您的应用程序。
学习
文档
每个Spring项目都有自己的; 它详细解释了如何使用项目功能以及使用它们可以实现的功能。
2.0.3 CURRENT GA | Reference Doc. | API Doc. |
2.0.4 SNAPSHOT | Reference Doc. | API Doc. |
1.2.7 SNAPSHOT | Reference Doc. | API Doc. |
1.2.6 GA | Reference Doc. | API Doc. |
示例
尝试一些示例:
- Spring HATEOAS 演示为使用Spring HATEOAS实现的服务创建入门指南和API指南
- Spring Data REST 演示为使用Spring Data REST实现的服务创建入门指南和API指南
- Web Test Client 演示Spring REST文档与Spring WebFlux的WebTestClient的使用
- Grails 演示如何使用Grails和Spock的Spring REST文档。
- Slate 演示使用Markdown和Slate的Spring REST Docs
- TestNG 演示Spring REST Docs与TestNG的使用
- JUnit 5 演示使用JUnit 5的Spring REST Docs
纸上得来终觉浅,绝知此事要躬行。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】博客园社区专享云产品让利特惠,阿里云新客6.5折上折
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· CSnakes vs Python.NET:高效嵌入与灵活互通的跨语言方案对比
· DeepSeek “源神”启动!「GitHub 热点速览」
· 我与微信审核的“相爱相杀”看个人小程序副业
· Plotly.NET 一个为 .NET 打造的强大开源交互式图表库
· 上周热点回顾(2.17-2.23)
2023-08-29 Java使用Apache POI导出-注意前端不要使用Ajax异步请求
2023-08-29 NoSql之MongoDB实现数据库数据操作
2016-08-29 推荐20款前端和网页设计师都需要的代码工具