介绍
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 而非其具体实现。 它还使您能够自由地演进实现，而无需重新编写文档。