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