当一个应用需要对第三方提供服务接口时，
REST API 是目前主流的选择。
对于 REST API 的开发者来说，
不管 API 的用户是内部团队还是第三方，
高质量的文档都是不可或缺的。
事实上长久以来，
API 文档的正确性一直困扰着开发人员。
创建文档并不难，
难的是如何维护文档，
让文档与代码的变化保持同步。
Spring REST Doc，
为创建和维护 REST API 文档
给出了另外一种思路——
手写文档和自动生成相结合。
Spring REST Doc的手写文档用来提供必要的背景知识和相关介绍，而基于单元测试的自动生成文档用来产生真实有效的 HTTP 请求和响应相关的内容。由于自动生成的部分是基于单元测试的，可以保证文档的准确性，否则单元测试就会失败。
今天，我们就来详细了解 Spring REST Docs，包括基本的配置和对 HTTP 请求和响应的不同部分添加文档。
即刻点击“阅读原文”获得完整文章，REST API 文档的准确性由我们来守护！