录制于 SpringOne2GX 2015。主题：Web / Javascript 主题 演讲者：Andy Wilkinson 幻灯片：http://www.slideshare.net/SpringCentral/documenting-restful-apis API 的文档是使其易于理解和易于使用的重要组成部分。RESTful API 也不例外。在本次演讲中，我们将探讨您的 RESTful API 文档应包含哪些内容，以及同样重要的是，应省略哪些内容。我们将使用真实的、好的和坏的例子，讨论文档应如何组织，以便信息丰富、简洁且易于阅读。在确定了好的文档是什么样子之后，我们将讨论一些可用于记录使用 Spring 构建的服务。特别是，我们将探讨选择 Swagger 等工具时遇到的一些问题和局限性，以及 Spring REST Docs 等一些替代方案如何避免这些不足，并帮助您生成用户喜爱的文档。