摘要：只需要填寫測試的參數(shù)值，點擊下方運行按鈕，即可發(fā)起一次接口請求，請求結果將會在下方顯示出來保存歷史在接口測試界面，在進行接口測試后點擊下方保存按鈕將會把本次測試數(shù)據(jù)接口，測試參數(shù)等信息保存下來。

XXL-API是一個簡潔易用API管理平臺，提供API的"管理"、"文檔"、"Mock"和"測試"等功能。現(xiàn)已開放源代碼，開箱即用。

1、極致簡單：交互簡潔，一分鐘上手；

2、項目隔離：API以項目為維度進行拆分隔離；

3、分組管理：單個項目內的API支持自定義分組進行管理；

4、標記星級：支持標注API星級，標記后優(yōu)先展示；

5、API管理：創(chuàng)建、更新和刪除API；

6、API屬性完善：支持設置豐富的API屬性如：API狀態(tài)、請求方法、請求URL、請求頭部、請求參數(shù)、響應結果、響應結果格式、響應結果參數(shù)、API備注等等；

7、markdown：支持為API添加markdown格式的備注信息；

8、Mock：支持為API定義Mock數(shù)據(jù)并制定數(shù)據(jù)響應格式，從而快速提供Mock接口，加快開發(fā)進度；

9、在線測試：支持在線對API進行測試并保存測試數(shù)據(jù)，提供接口測試效率；

源碼地址 (將會在兩個git倉庫同步發(fā)布最新代碼)

github地址

git.osc地址

博客地址 (將會在兩個博客同步更新文檔)

oschina地址

cnblogs地址

技術交流群 (僅作技術交流)

群2：438249535

群1：367260654 （群1已滿，請加群2）

Servlet/JSP Spec：3.0/2.2

JDK：1.7+

Tomcat：7+/Jetty8+

Mysql：5.6+

Maven：3+

請下載項目源碼并解壓，獲取 "初始化SQL腳本"，腳本位置：

/xxl-api/db/xxl-api-mysql.sql

解壓源碼,按照maven格式將源碼導入IDE, 使用maven進行編譯即可，源碼結構如下圖所示：

在以下項目文件中設置應用的JDBC連接；

/xxl-api/xxl-api-admin/src/main/resources/xxl-api.properties

將應用"xxl-api-admin"部署在容器如Tomcat下之后，啟動后訪問即可進入以下界面：

系統(tǒng)中API以項目為單位進行管理，因此首先需要管理項目；項目管理界面如下圖所示；

進入項目管理界面，點擊右側"+新增項目"按鈕可新建項目，如下圖所示：

項目屬性說明：

項目名稱：項目的名稱；
項目描述：項目的描述信息；
訪問權限："公開"權限，表示所有人可操作；"私有"權限，表示只有管理員或者項目成員可以操作（功能自測中，即將推送）；
跟地址-線上環(huán)境：項目線上環(huán)境跟地址，項目中的API共用該跟地址；
跟地址-預發(fā)布環(huán)境：項目預發(fā)布環(huán)境跟地址；
跟地址-測試環(huán)境：項目測試環(huán)境跟地址；
版本：項目的版本信息；

進入項目管理界面，點擊項目右側的"編輯"按鈕可更新項目信息，如下圖所示；

進入項目管理界面，點擊項目右側的"刪除"按鈕可刪除項目信息；注意，項目中存在API時不允許刪除；

在項目管理界面，點擊項目右側的"進入項目"按鈕，可進入接口管理界面，如下圖所示：

新增API分組

如下圖，點擊"左側接口分組區(qū)域"右上角的"+"按鈕，可新增AIP接口分組；（點擊"全部"將會展示項目中所有分組下的接口；"默認分組"為系統(tǒng)分組，不允許刪除；）

接口分組屬性說明：

分組名稱：分組的名稱
分組排序：分組的排序順序，數(shù)字類型，值越小越靠前；

更新API分組

在"左側接口分組區(qū)域"，點擊對應的API分組，右側將會展示該分組下API接口列表；如下圖，點擊接口列表頂部的"編輯分組"按鈕（新增的API分組才會有該功能），可修改API分組信息；

刪除API分組

在"左側接口分組區(qū)域"，點擊對應的API分組，右側將會展示該分組下API接口列表；點擊接口列表頂部的"刪除分組"按鈕（新增的API分組才會有該功能），可修改API分組信息；

新增API

如下圖，在API接口管理界面，點擊接口列表頂部的"新增接口"按鈕，可進入新增接口界面；
在新增接口界面，如下圖所示，可以設置接口的API狀態(tài)、請求方法、請求URL、請求頭部、請求參數(shù)、響應結果、響應結果格式、響應結果參數(shù)、API備注等等信息；

API屬性說明：

基礎信息：
    接口分組：接口所屬的分組；
    接口狀態(tài)：接口的狀態(tài)，在接口列表中，啟用狀態(tài)接口用綠色圓圈標識，維護狀態(tài)接口用黃色圓圈標識，廢棄狀態(tài)接口用灰色圓圈標識；
    請求方法：請求方法，如POST、GET等；
    接口URL：接口請求的URL地址，注意此處為相對地址，跟地址從所屬項目的跟地址屬性上獲取；
    接口名稱：接口的名稱；
請求頭部：同一接口支持設置多個請求頭部；
    頭部標簽：請求頭部的類型，如Accept-Encoding；
    頭部內容：請求頭部的數(shù)據(jù)，如Accept-Encoding頭部標簽的頭部內容UTF-8；
請求參數(shù)：同一接口支持設置多個請求參數(shù)；
    是否必填：該參數(shù)是否必填；
    參數(shù)類型：該參數(shù)的數(shù)據(jù)類型，如STRING；
    參數(shù)名稱：參數(shù)的名稱；
    參數(shù)說明：參數(shù)的說明；
響應結果：分別支持設置 "成功響應結果" 和 "失敗響應結果"，作為接口響應數(shù)據(jù)的參考；
    響應數(shù)據(jù)類型(MIME)：響應結果類型，如JSON、XML等；
    響應結果數(shù)據(jù)：響應結果的數(shù)據(jù)，如響應結果類型為JSON時可設置響應結果數(shù)據(jù)為一段JSON數(shù)據(jù)；
響應結果參數(shù)：對接口"響應結果"中參數(shù)的補充說明，如響應結果類型為JSON時，可在此處一一列出JSON各個字段的參數(shù)信息；
    是否非空：該參數(shù)是否可能為空；
    參數(shù)類型：該參數(shù)的數(shù)據(jù)類型，如STRING；
    參數(shù)名稱：參數(shù)的名稱；
    參數(shù)說明：參數(shù)的說明；
接口備注：markdown方式的接口備注；

更新API

在API接口管理界面，點擊接口右側的"更新接口圖標"按鈕，可進入更新接口界面；

刪除API

在API接口管理界面，點擊接口右側的"刪除接口圖標"按鈕，可刪除接口數(shù)據(jù)；

新增Mock數(shù)據(jù)

在API接口管理界面，點擊接口名稱，進入"接口詳情頁"，在接口詳情頁的"Mock數(shù)據(jù)"模塊右上角點擊"+Mock數(shù)據(jù)"按鈕，可新增Mock數(shù)據(jù)；

Mock數(shù)據(jù)屬性說明：

數(shù)據(jù)類型(MIME)：響應結果類型，如JSON、XML等；
結果數(shù)據(jù)：響應結果的數(shù)據(jù)，如響應結果類型為JSON時可設置響應結果數(shù)據(jù)為一段JSON數(shù)據(jù)；

更新Mock數(shù)據(jù)

在"接口詳情頁"的"Mock數(shù)據(jù)"模塊，點擊Mock數(shù)據(jù)列表右側的"修改"按鈕，可修改Mock數(shù)據(jù)；

刪除Mock數(shù)據(jù)

在"接口詳情頁"的"Mock數(shù)據(jù)"模塊，點擊Mock數(shù)據(jù)列表右側的"刪除"按鈕，可刪除Mock數(shù)據(jù)；

運行Mock數(shù)據(jù)

在"接口詳情頁"的"Mock數(shù)據(jù)"模塊，點擊Mock數(shù)據(jù)列表右側的"運行"按鈕，可運行Mock數(shù)據(jù)；
系統(tǒng)將會為每一條Mock數(shù)據(jù)生成一個唯一的Mock連接，訪問該連接將會按照設置的數(shù)據(jù)類型如JSON返回對應格式的Mock數(shù)據(jù)，如下圖所示；

API-測試

進入"接口詳情頁"，點擊"Test歷史"模塊右上角的"+接口測試"按鈕，可進入"接口測試界面"，
該界面將會自動初始化接口URL（測試界面支持選擇運行環(huán)境，將會自動生成不同環(huán)境的完整URL連接）和參數(shù)等信息。
只需要填寫測試的參數(shù)值，點擊下方"運行"按鈕，即可發(fā)起一次接口請求，請求結果將會在下方顯示出來：

保存Test歷史

在"接口測試界面"，在進行接口測試后, 點擊下方"保存"按鈕將會把本次測試數(shù)據(jù)（接口URL，測試參數(shù)等信息）保存下來。
在"接口詳情頁"的"Test歷史"模塊可查看所有的接口測試歷史記錄。點擊一次測試記錄右側的"運行"按鈕，將會進入到本次測試記錄對應的接口測試界面，還原當時測試時使用的測試數(shù)據(jù)；

刪除Test歷史

在"接口詳情頁"的"Test歷史"模塊，點擊測試歷史記錄右側的"刪除"按鈕可刪除本條記錄；

進入用戶管理界面，點擊右上角"+新增用戶"按鈕，可添加用戶信息；

用戶屬性說明：

登錄賬號：用戶的登錄賬號；
登錄密碼：用戶的登錄密碼；
用戶類型：
    普通用戶：只允許操作公開項目，或者自己擁有項目權限的私有項目；
    超級管理員：擁有所有項目的操作權限；
真實姓名：用戶的真實姓名；

進入用戶管理界面，點擊用戶列表頁中用戶右側的"編輯"按鈕可編譯用戶信息；

進入用戶管理界面，點擊用戶列表頁中用戶右側的"刪除"按鈕可刪除用戶信息；

1、極致簡單：交互簡潔，一分鐘上手；

2、項目隔離：API以項目為維度進行拆分隔離；

3、分組管理：單個項目內的API支持自定義分組進行管理；

4、標記星級：支持標注API星級，標記后優(yōu)先展示；

5、API管理：創(chuàng)建、更新和刪除API；

6、API屬性完善：支持設置豐富的API屬性如：API狀態(tài)、請求方法、請求URL、請求頭部、請求參數(shù)、響應結果、響應結果格式、響應結果參數(shù)、API備注等等；

7、markdown：支持為API添加markdown格式的備注信息；

8、Mock：支持為API定義Mock數(shù)據(jù)并制定數(shù)據(jù)響應格式，從而快速提供Mock接口，加快開發(fā)進度；

9、在線測試：支持在線對API進行測試并保存測試數(shù)據(jù)，提供接口測試效率；

1、項目權限：支持對項目設置權限，擁有權限才允許操作項目中API；

1、項目權限：支持對項目設置權限，擁有權限才允許操作項目中API；

2、API歷史版本：支持對API修改歷史版本進行對比，版本回溯等操作；

XXL-API托管在Github上，如有問題可在 ISSUES 上提問，也可以加入上文技術交流群；

更多接入公司，歡迎在github 登記