Spring系列学习之Spring REST Docs

英文原文：https://spring.io/projects/spring-restdocs

目录

概述

Spring Boot配置

快速开始

学习

文档

示例

---

概述

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