介绍
Spring REST Docs 的目标是帮助你为 RESTful 服务生成准确且可读的文档。
编写高质量的文档很困难。 缓解这种困难的一种方法是使用非常适合工作的工具。 为此，Spring REST Docs 默认使用 Asciidoctor。 Asciidoctor 处理纯文本并生成 HTML，并根据您的需求进行样式和布局。 如果你愿意，你还可以将 Spring REST Docs 配置为使用 Markdown。
Spring REST Docs 使用由 Spring MVC 的测试框架、Spring WebFlux 的 WebTestClient 或 REST Assured 5 编写的测试生成的代码片段。
这种测试驱动方法有助于保证服务文档的准确性。
如果代码段不正确，则生成该代码段的测试将失败。
记录 RESTful 服务主要是描述其资源。 每个资源描述的两个关键部分是它使用的 HTTP 请求的详细信息和它生成的 HTTP 响应。 Spring REST Docs 允许你使用这些资源以及 HTTP 请求和响应，从而保护你的文档免受服务实现的内部细节的影响。 这种分离有助于您记录服务的 API，而不是其实现。 它还使您可以自由地改进实施，而无需重新编写文档。