創(chuàng)建API

API基本信息

進(jìn)入 API文檔 頁面，點擊 新建API 按鈕，進(jìn)入到 API編輯 頁面。

設(shè)置API分組

最多支持三級分組，對API進(jìn)行適當(dāng)?shù)臍w類有助于提高管理效率。

設(shè)置API URL以及API名稱

如果您有多個項目環(huán)境，不同的項目環(huán)境擁有不同的請求URL前綴，那么URL僅需要填寫API的路徑即可（如/user/login），切換不同的URL前綴可以使用eoLinker AMS中的環(huán)境管理功能。相關(guān)教程請前往 API開發(fā)管理 > 公共資源管理 > 環(huán)境管理 一節(jié)。

設(shè)置API狀態(tài)

在eoLinker AMS中，API擁有以下的幾種狀態(tài)：

請求信息

在API文檔中，您可以記錄Header、Request Body、REST Params、Query/GET Params、鑒權(quán)等信息。

設(shè)置Header

請求頭部中，你可以手動輸入接口的頭部信息，也可以使用 導(dǎo)入頭部 的功能批量導(dǎo)入：

設(shè)置Request Body

Body請求參數(shù)提供了兩種類型：Form-data或者Raw。您可以您可以手動輸入請求參數(shù)或者使用 導(dǎo)入JSON / 導(dǎo)入XML 功能來批量導(dǎo)入請求參數(shù)。

同時，F(xiàn)orm-data支持記錄無限層級結(jié)構(gòu)的請求參數(shù)，參數(shù)層級通過 “>>” 表示并且能對每個參數(shù)設(shè)定非常詳細(xì)的示例和值可能性等：

設(shè)置REST Params

在eoLinker AMS中，REST參數(shù)在URL中使用 {param_name} 表示，如 /user/login/{user_name}/{user_type}，該API擁有REST參數(shù)user_name和user_type。

注意，您只需要在URL中使用{}將REST參數(shù)括起來，下方的表格中不需要使用{}。

返回參數(shù)

您可以您可以手動輸入請求參數(shù)或者使用 導(dǎo)入JSON / 導(dǎo)入XML 功能來批量導(dǎo)入請求參數(shù)。

返回示例

您可以記錄API請求成功或失敗的示例，eoLinker AMS提供了API來獲取編寫好的API返回示例，可以用于前端開發(fā)人員測試API。

保存API文檔之后，通過返回示例API即可獲得事先編寫好的返回示例：

API詳細(xì)文檔

當(dāng)API文檔無法詳細(xì)地記錄下您的API信息時，您可以通過使用Markdown或者富文本的方式來編寫需要補(bǔ)充的信息：

Mock API

如需了解如何設(shè)置Mock API的生成規(guī)則，請移步至 API開發(fā)管理 > Mock API > 設(shè)置MockAPI 一節(jié)中查看。