Spring REST Docs
2.0.3
Spring REST Docs可帮助您记录RESTful服务。
它结合了用Asciidoctor编写的手写文档和Spring MVC Test生成的自动生成的代码片段。这种方法使您摆脱了Swagger之类的工具所产生的文档限制。
它可以帮助您生成准确，简洁且结构合理的文档。然后，该文档可让您的用户以最少的麻烦获得他们所需的信息。
Spring Boot配置
Spring Boot提供了一个@AutoConfigureRestDocsannotation，以在测试中利用Spring REST Docs 。
快速开始
使用Spring Initializr引导您的应用程序。
可以尝试一些示例：
- Spring HATEOAS 演示为使用Spring HATEOAS实现的服务创建入门指南和API指南
- Spring Data REST 演示为使用Spring Data REST实现的服务创建入门指南和API指南
- Web测试客户端 演示了将Spring REST文档与Spring WebFlux的WebTestClient一起使用
- Grails 演示了将Spring REST文档与Grails和Spock一起使用。
- Slate 演示将Spring REST Docs与Markdown和Slate结合使用
- TestNG 演示将Spring REST Docs与TestNG一起使用
- JUnit 5 演示将Spring REST Docs与JUnit 5一起使用