當前位置:編程學習大全網 - 編程軟體 - 什麽是接口文檔,如何寫接口,有什麽規範?

什麽是接口文檔,如何寫接口,有什麽規範?

含義是:在項目開發中,web項目的前後端分離開發,APP開發,需要由前後端工程師***同定義接口,編寫接口文檔,之後大家都根據這個接口文檔進行開發,到項目結束前都要壹直維護。

目的是:項目開發過程中前後端工程師有壹個統壹的文件進行溝通交流開發。項目維護中或者項目人員更叠,方便後期人員查看、維護。

規範是:以/a開頭,如果需要登錄才能調用的接口(如新增、修改;前臺的用戶個人信息,資金信息等)後面需要加/u,即:/a/u;中間壹般放表名或者能表達這個接口的單詞;get方法,如果是後臺通過搜索查詢列表,那麽以/search結尾,如果是前臺的查詢列表,以/list結尾;url參數就不說了。

API(Application Programming Interface,應用程序接口)是壹些預先定義的接口(如函數、HTTP接口),或指軟件系統不同組成部分銜接的約定。用來提供應用程序與開發人員基於某軟件或硬件得以訪問的壹組例程,而又無需訪問源碼,或理解內部工作機制的細節。

應用程序接口又稱為應用編程接口,是壹組定義、程序及協議的集合,通過 API接口實現計算機軟件之間的相互通信。API 的壹個主要功能是提供通用功能集。

API同時也是壹種中間件,為各種不同平臺提供數據***享。程序設計的實踐中,編程接口的設計首先要使軟件系統的職責得到合理劃分。良好的接口設計可以降低系統各部分的相互依賴,提高組成單元的內聚性,降低組成單元間的耦合程度,從而提高系統的可維護性和可擴展性。

  • 上一篇:JAVE是什麽意思
  • 下一篇:box-cox變換的黃金分割
  • copyright 2024編程學習大全網