好的API檔案不是隨意就可以生成的，它需要明確的指導方案、團隊一致的努力、嚴格的用戶評審以及在API的整個生命周期中維護檔案，如果需要撰寫的好的API檔案則應該包括：
必要的組件，完整的檔案通常包含有引數說明、錯誤訊息、回應資訊、示例，以及全面的更改日志的部分，一些API檔案還包括一系列指南，這些指南提供了API使用和用例的詳細示例，
了解目標用戶，為目標用戶量身定制API檔案，如果該檔案是為新手開發人員準備的，需要專注于教程，示例和指南，如果檔案是為有經驗的開發人員準備的，則需要構建詳細說明語法，引數，自變數和回應詳細資訊的參考資料，
分配檔案職責，開發團隊的一名或多名成員應開發和維護API檔案，以確保檔案的準確性，清晰性和易用性，好的API檔案工具可以從單個人的創建、添加注釋、示例和其他基本組件中獲益，可以將此職責交給能使檔案易于訪問并且與其他部門（例如產品開發，市場）有合作的人員，
API檔案的覆寫范圍，語法參考、示例和指南創建了API檔案的技術核心，例如，對于每個呼叫或請求，語法參考的長度應該大致相同，并且包含相同的元素，如果一個功能的詳細資訊超過五頁，而另一個功能只有半頁，則檔案可能不完整，類似地，注意那些只顯示一小部分API呼叫的示例，或者忽略了處理回應（如錯誤訊息）的示例，
將檔案帶入開發程序，如果將API檔案包含在迭代開發程序中，通常會更好，對于每個新版本，檔案都應進行相應的更新和更改，將API檔案作為事后思考或單獨的任務來處理會導致API檔案不全面，創建全面的API檔案需要花費時間和精力，但是值得進行投資，缺少、不完整或不正確的API檔案可能會使API管理變得困難，
演示工具：Eolinker
使用地址：www.eolinker.com
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/232927.html
標籤：其他