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