開發人員使用API定義軟體和服務之間的互動，但是一個專案不僅僅只創建一個API，而API檔案影響API的使用，企業在給定的服務創建一個API，以便團隊內部人員，業務合作伙伴甚至公共的開發人員可以將其各自的軟體與該服務集成，例如百度地圖，在位置服務方面發揮著重要的作用，

API本身并不是需要所有用戶從服務中獲取價值，在API中規定著可用的API呼叫或請求、語法、規則、資料格式和其他資訊，好的檔案幾乎和API的底層代碼一樣重要，沒有良好的API檔案可能會導致用戶花大量時間學習如何使用并且容易出差錯，這會減慢連接到API服務的應用程式的開發和性能，

API檔案的基本資訊

檔案是有關API的主要資訊源，其中包括：
API可用的特性和功能；
全面的功能和語法參考；
教程、示例，
獲取支持或其他資訊，
API檔案有三大類：參考、示例和教程，
參考檔案涵蓋了API的詳細資訊，它詳細說明了API支持的每個呼叫或請求的目的，功能和完整語法，

示例檔案使用參考檔案中的詳細說明提供API用例的眾多示例，

教程檔案著重于為API提供背景關系，API檔案通常包括一系列基于示例的指南和教程，用來提供有關API使用的全面討論，教程和指南通常顯示了多個API呼叫和請求如何在實際代碼段的背景關系中一起作業，以完成除單個呼叫之外的任務，

API檔案工具

由上可知，API檔案難以生成和維護，幾乎所有的檔案都是這樣，但是撰寫API檔案特別具有挑戰性，因為涉及到無數的技術細節，一些小的檔案錯誤，都可能會使API呼叫失敗，API數量是另一個問題，一個團隊的每一個附加的API都會產生更多的API檔案來維護，再加上軟體開發周期的不斷縮短，使得開發人員幾乎沒有時間創建和維護高質量的API檔案，

有許多商業和開源工具可用于自動化和組織API檔案（確保一致的樣式和內容），大多數自動化的API管理工具都使用OpenAPI規范，該規范概述了描述、產生、使用和可視化RESTful Web API的標準化格式，該標準化規范有助于開發團隊快速生成一致的檔案，并避免因手動檔案嘗試而引起的錯誤，

翻譯：Eolinker
演示工具：www.eolinker.com

轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/233422.html

標籤：其他

上一篇：pytest---pycharm執行pytest加入命令列引數

下一篇：Api管理必備組件