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