如何正確規(guī)范寫接口文檔？編寫文檔，無論是接口文檔還是需求文檔。關(guān)鍵是雙方都需要能夠在第一時(shí)間理解并達(dá)成共識(shí)，這是一個(gè)好的文件。對(duì)接口文檔有幾點(diǎn)建議：1。前提條件應(yīng)該明確定義前提條件包括接口環(huán)境、項(xiàng)目版

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

編寫文檔，無論是接口文檔還是需求文檔。關(guān)鍵是雙方都需要能夠在第一時(shí)間理解并達(dá)成共識(shí)，這是一個(gè)好的文件。

對(duì)接口文檔有幾點(diǎn)建議：1。前提條件應(yīng)該明確定義

前提條件包括接口環(huán)境、項(xiàng)目版本號(hào)等，因?yàn)樵S多公司同時(shí)運(yùn)行多個(gè)版本。在不注意前提的情況下，很容易出現(xiàn)一些讓人歡笑的事情。測(cè)試過程中有很多問題。結(jié)果發(fā)現(xiàn)前端環(huán)境或者版本號(hào)是錯(cuò)誤的，浪費(fèi)了很多時(shí)間，沒有意義。

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

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

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

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