什么是API檔案？
API檔案是一份可交付的技術內容，其中包含有關如何有效使用和集成API的說明，這也是一本簡單明了的參考手冊，撰寫了使用API所需的所有資訊，以及有關功能、回傳型別、引數等詳細資訊，并提供了教程和示例支持，
API檔案通常由常規的內容創建和維護工具以及文本編輯器完成的，例如 Swagger、eolinker規范之類的API描述格式已經自動化了檔案處理程序，從而使團隊可以更輕松地生成和維護API，
第三方開發人員是API的主要用戶，正忙于解決復雜的編程難題，API是技術用戶達到目的的一種手段，他們希望盡快集成推進他們的軟體開發，這意味著他們應該快速了解你的API的價值和用途，開發人員在發現、學習使用并最終與API集成時所積累的經驗稱為開發人員經驗，API檔案是獲得出色開發人員經驗的關鍵，
為什么要使用檔案API？
在API生命周期的所有階段中，檔案可能是增長最快的領域，對于圍繞檔案的工具生態系統尤其如此，注意到這一趨勢很有趣，因為從傳統上講，檔案是開發人員在撰寫代碼時很少關注的東西，實際上，實作代碼比撰寫良好的檔案要容易得多，
提高用戶使用率
擁有良好的API檔案的一個重要原因是，它改善了開發人員使用API的體驗，這與API的采用直接相關，如果API檔案正確無誤，那么更多的人將很容易在提供的服務中發現價值，從而可以更好地發展和采用，
節省支持時間和成本
好的檔案還可以減少新用戶（無論是內部開發人員還是外部合作伙伴）的培訓時間，糟糕的檔案或者沒有檔案意味著更多用戶依賴于團隊培訓來理解如何使用API，
相反，當你在用戶使用API之前先試用API，并且配備詳細的api檔案，將為團隊節省大量時間來回復電子郵件和電話，
易于維護
檔案可帶來良好的產品維護，它可以幫助內部團隊了解資源、方法及其相關請求和回應的詳細資訊，從而可以更快地進行維護和更新，
結語
使用API時，檔案是獲得良好體驗的關鍵，它不僅能提高用戶滿意度，還可以提高API的使用率，在提供優秀的API檔案的條件下，api管理平臺還支持測驗、監控等功能，讓用戶在使用API方面獲得出色的體驗，
原文：https://dzone.com/articles/what-is-api-documentation-and-why-does-it-matter
翻譯：www.eolinker.com
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/230910.html
標籤：其他