(您可以在這裡找到簡報的投影片。)開發者體驗是一般使用者體驗的延伸,它強調開發人員以及他們在使用您的 API 時的體驗。良好的 API 開發者體驗不僅僅是技術寫作。它還包括提供所有正確的資源,以幫助您的最終使用者成功整合和使用您的 API。
文件在 DX 中的作用
設計良好的開發人員體驗以 API 文件為中心。 API 文件是成功使用和整合 API 所需的資訊。這將以技術寫作、程式碼範例和範例的形式呈現,以便更好地理解如何使用 API。 根據 SmartBear 的 2016 年 API 狀態報告,現在有 75% 的開發 API 組織具有正式的文件流程。46% 的組織表示這對他們而言是高度優先事項。 對於希望推動其 API 採用的組織來說,簡潔明瞭的文件(使您的 API 消費者可以快速將其應用到他們的應用程式中)不再是可選的。
良好的文件並非易事
對於許多 API 團隊來說,文件仍然是一項繁瑣且耗時的工作。對於依賴於靜態文件,並且每次發布新版本的 API 時都需要手動更新的團隊來說,尤其如此。 但是,組織記錄 API 的方式也發生了一些重大變化。這些變化在 API 描述格式(如 Swagger)的廣泛採用中體現得最為明顯。 Swagger 是一個開放原始碼 API 框架,可讓開發人員和團隊設計、建置、文件化和使用 RESTful Web 服務。Swagger 框架獲得如此廣泛採用的最大原因之一是能夠產生互動式文件。此文件允許任何人(無論是您的開發團隊還是您的最終使用者)視覺化和使用 API 的資源,而無需任何實作邏輯。 此自動產生的文件是一個中心資源,您的開發團隊可以自訂並在此基礎上建立更全面的使用者手冊,以使用您的 API。
將 Swagger 新增到您的文件中
無論您是 Swagger 的新手,還是已經使用該框架進行 API 設計,您都很有可能仍然對如何改進 API 文件有疑問。建立您的消費者會喜歡的 API 文件可能需要一些工作,但是這項投資將以良好的開發人員體驗、更輕鬆的實作和改進您的 API 採用率的形式帶來顯著的回報。 這個月,我們舉辦了有關 API 文件的免費培訓,API 開發者體驗:為什麼重要,以及如何使用 Swagger 文件化您的 API 來提供幫助。 我們詳細介紹了良好的開發人員體驗,重點關注為什麼以及如何為使用您的 API 的開發人員提供最佳體驗。我們還將介紹 Swagger 如何改變 API 設計和文件化領域,並最終展示一些使用 Swagger 在 SwaggerHub 的整合式 API 開發平台中進行 API 文件化的良好做法。 此網路研討會的預期內容:
- 什麼是開發人員體驗 (DX)?
- 對 API 而言,擁有良好的 DX 意味著什麼?
- 在良好的 DX 環境下的 API 文件?
- Swagger 框架簡介
- 使用 Swagger 和 SwaggerHub 從可用性的角度設計 API