按照什么規(guī)范制定http接口文檔？在項目開發(fā)中，分別開發(fā)了web項目的前端和后端，并開發(fā)了應用程序。前端和后端工程師需要共同定義接口并編寫接口文檔。之后，我們都按照接口文檔進行開發(fā)，并維護到項目結束。

按照什么規(guī)范制定http接口文檔？

在項目開發(fā)中，分別開發(fā)了web項目的前端和后端，并開發(fā)了應用程序。前端和后端工程師需要共同定義接口并編寫接口文檔。之后，我們都按照接口文檔進行開發(fā)，并維護到項目結束。

如何正確規(guī)范寫接口文檔？

編寫文檔，無論是接口文檔還是需求文檔。關鍵是雙方都需要能夠在第一時間理解并達成共識，這是一個好的文件。

對接口文檔有幾點建議：1。前提條件應該明確定義

前提條件包括接口環(huán)境、項目版本號等，因為許多公司同時運行多個版本。在不注意前提的情況下，很容易出現一些讓人歡笑的事情。測試過程中有很多問題。結果發(fā)現前端環(huán)境或者版本號是錯誤的，浪費了很多時間，沒有意義。

2. 需要定義一般退貨編碼

一般退貨編碼包括一般成功、一般異常等，此類一般退貨內容可以定義一次，以下關于業(yè)務處理的退貨編碼可以省略，不能寫入這些內容；

3。必須給出參數傳遞和返回的例子

例子可以很好的避免一些不必要的問題，一個好的接口文檔可能就是一些例子。節(jié)省時間和精力。

文件標準格式規(guī)范？

文檔格式標準

1。A4頁，中等尺寸選擇

2。中國人用宋體。第五篇，標題，小四，大標題。。。

3. 數字、英文字母等用新羅馬