Api接口文檔的編寫及Api接口聯調

Api接口文檔的編寫

為了友善協調用戶端和服務端的開發，比如我們寫好了服務端接口，用戶端就需要調用，是以我們需要寫接口文檔以便于用戶端調用，這樣也能提高開發效率。

有利于用戶端工程師熟悉接口

有利于服務端工程師接手項目

對于api的接口文檔的編寫，我們要寫上入參和出參的資料格式，我們可以使用word，pdf，wiki進行文檔編寫，當然我們也可以使用線上文檔編寫接口。

api接口必須包含以下内容:

api接口位址

請求方式:get put post delete

入參格式

出參格式

http code

1使用postman生成接口文檔

1在postman上注冊一個使用者賬号和密碼，完善個人資訊

2建立一個collection建立時填好名稱和描述（項目的名稱）

3在collecttion下面建立一個目錄（項目的子產品）

4在目錄下可以建立多個請求

5每個請求下可以建立多個執行個體（比如成功執行個體和錯誤執行個體）

6可以釋出一個collection

2使用https://www.showdoc.cc 生成接口文檔（推薦使用）

1 先注冊一個showdoc的賬号和密碼。

2 我們可以建立一個項目

3 我們可以在項目中建立目錄結構

4 我們可以建立文檔，選擇文檔的模闆。

注意:我們也可以使用api線上調試工具，調試接口一旦調試成功，我們可以生成markdown格式的文本，然後填充到api接口模闆中。

接口聯調

項目完成後我們要和前端的開發人員進行接口聯調。一般有一個測試環境，在測試環境測試沒問題，我們在進行上線營運。