錄製於 SpringOne2GX 2015。主題：Web / Javascript 主題 演講者：Andy Wilkinson 幻燈片：http://www.slideshare.net/SpringCentral/documenting-restful-apis API 的文件是使其易於理解和易於使用的重要組成部分。RESTful API 也不例外。在本次演講中，我們將探討您的 RESTful API 文件應包含哪些內容，以及同樣重要的是，應省略哪些內容。我們將使用真實的、好的和壞的例子，討論文件應如何組織，以便資訊豐富、簡潔且易於閱讀。在確定了好的文件是什麼樣子之後，我們將討論一些可用於記錄使用 Spring 構建的服務。特別是，我們將探討選擇 Swagger 等工具時遇到的一些問題和侷限性，以及 Spring REST Docs 等一些替代方案如何避免這些不足，並幫助您生成使用者喜愛的文件。