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