乙份規範的介面文件應該包括什麼內容?

2021-09-29 07:33:22 字數 1053 閱讀 1822

1.介面文件是什麼

在專案開發彙總,web專案的前後端是分離開發的。應用程式的開發,需要由前後端工程師共同定義介面,編寫介面文件,之後大家都根據這個介面文件進行開發,到專案結束前都要一直維護。

2.為什麼要寫介面文件?

1)專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發

2)專案維護中或者專案人員更迭的時候,方便後期人員檢視、維護

3.回顧介面的知識

要了解介面文件的規範,首先要了解介面。介面分為四部分:方法、uri、請求引數、返回引數:

1)方法:常用的方法就是下面的四種:get put post delete

2)uri:以/a開頭,如果需要登入才能呼叫的介面(如新增、修改;前台的使用者個人資訊,資金資訊等)後面需要加/u,即:/a/u;中間一般放表名或者能表達這個介面的單詞。get方法,若果是後台通過搜尋查詢列表,那麼以/search結尾,如果是前台的查詢列表,以/list結尾。uri位址裡不遜於出現大寫字母,如果是兩個單詞拼接,用/分開

3)請求引數和返回引數:請求引數和返回引數都分為:字段、說明、型別、備註、是否必填這5列。

字段:類的屬性

說明:中文釋義

型別:屬性的型別,只有string、number、object、array四大類

備註:一些解釋語,或者寫簡單的示例

4)返回引數,要分兩種情況討論:

只返回介面呼叫成功或者失敗:code、reason

返回引數:字段、型別

3.常見問題

乙份規範的介面文件應該包括什麼內容

4.解決方案

除了上面提到的請求方法、uri、請求引數、返回引數以外,還應該新增介面示例、介面文件版本號、版本修改內容、版本修改時間、修改人,錯誤**等。

5.示例:

下面是在**上找到的乙個介面文件示例

6.輔助工具

最後,我再推薦一款編寫介面文件的工具,可以模擬資料輔助測試。聽說阿里團隊都是用的這一款工具編寫介面文件。

處。

如何編寫乙份介面文件

編寫乙份基本的介面檔案要注意以下幾點 1.一定要有版本號,因為基本上對應的介面都是剛開發或者待開發的 已經正常使用的介面也不需要你來寫文件 不可能一次提供最終版,方便後續更改,同時避免因為修改多次導致雙方使用不一樣的文件而出錯。2.封皮要有,帶公司logo的那種,目錄要有,時間要有 建立時間,修改時...

乙份成功的專案總結應該包括哪些內容

一 專案總結要根據報告物件的不同進行調整 1 開始前要想清楚報告物件的需求和關注點是什麼,如何用報告去覆蓋和滿足 2 尤其是大專案的總結,應視具體報告物件的需求和關注點進行文字或口頭表達的調整,比如 向總經理匯報,可能有下述結構的第一部分就夠了,但要突出專案對公司戰略意義,目標達成情況,或加入對未來...

第乙份工作應該做什麼???

1997年7月,我走出校門正式成為一名社會人。十年過去了,回憶自己初入社會的經歷,感觸很多。畢業求職受挫 畢業於我而言第一感覺就是解脫 再也不用考試了 再也不用上課了!好啊!至少當時這麼認為的 隨之而來是對未來的一片迷茫。就知道走向社會後應該工作,至於做什麼完全沒有概念。當時我用業務時間在麥當勞作乙...