摘要:只需要填寫測(cè)試的參數(shù)值,點(diǎn)擊下方運(yùn)行按鈕,即可發(fā)起一次接口請(qǐng)求,請(qǐng)求結(jié)果將會(huì)在下方顯示出來保存歷史在接口測(cè)試界面,在進(jìn)行接口測(cè)試后點(diǎn)擊下方保存按鈕將會(huì)把本次測(cè)試數(shù)據(jù)接口,測(cè)試參數(shù)等信息保存下來。
《API管理平臺(tái)XXL-API》 一、簡(jiǎn)介 1.1 概述
XXL-API是一個(gè)簡(jiǎn)潔易用API管理平臺(tái),提供API的"管理"、"文檔"、"Mock"和"測(cè)試"等功能。現(xiàn)已開放源代碼,開箱即用。
1.2 特性1、極致簡(jiǎn)單:交互簡(jiǎn)潔,一分鐘上手;
2、項(xiàng)目隔離:API以項(xiàng)目為維度進(jìn)行拆分隔離;
3、分組管理:?jiǎn)蝹€(gè)項(xiàng)目?jī)?nèi)的API支持自定義分組進(jìn)行管理;
4、標(biāo)記星級(jí):支持標(biāo)注API星級(jí),標(biāo)記后優(yōu)先展示;
5、API管理:創(chuàng)建、更新和刪除API;
6、API屬性完善:支持設(shè)置豐富的API屬性如:API狀態(tài)、請(qǐng)求方法、請(qǐng)求URL、請(qǐng)求頭部、請(qǐng)求參數(shù)、響應(yīng)結(jié)果、響應(yīng)結(jié)果格式、響應(yīng)結(jié)果參數(shù)、API備注等等;
7、markdown:支持為API添加markdown格式的備注信息;
8、Mock:支持為API定義Mock數(shù)據(jù)并制定數(shù)據(jù)響應(yīng)格式,從而快速提供Mock接口,加快開發(fā)進(jìn)度;
9、在線測(cè)試:支持在線對(duì)API進(jìn)行測(cè)試并保存測(cè)試數(shù)據(jù),提供接口測(cè)試效率;
1.3 下載github地址
git.osc地址
oschina地址
cnblogs地址
群2:438249535
群1:367260654 (群1已滿,請(qǐng)加群2)
1.4 環(huán)境Servlet/JSP Spec:3.0/2.2
JDK:1.7+
Tomcat:7+/Jetty8+
Mysql:5.6+
Maven:3+
二、快速部署 2.1 初始化“調(diào)度數(shù)據(jù)庫(kù)”請(qǐng)下載項(xiàng)目源碼并解壓,獲取 "初始化SQL腳本",腳本位置:
/xxl-api/db/xxl-api-mysql.sql2.2 編譯源碼
解壓源碼,按照maven格式將源碼導(dǎo)入IDE, 使用maven進(jìn)行編譯即可,源碼結(jié)構(gòu)如下圖所示:
2.3 配置JDBC連接在以下項(xiàng)目文件中設(shè)置應(yīng)用的JDBC連接;
/xxl-api/xxl-api-admin/src/main/resources/xxl-api.properties2.4 部署
將應(yīng)用"xxl-api-admin"部署在容器如Tomcat下之后,啟動(dòng)后訪問即可進(jìn)入以下界面:
三、項(xiàng)目管理系統(tǒng)中API以項(xiàng)目為單位進(jìn)行管理,因此首先需要管理項(xiàng)目;項(xiàng)目管理界面如下圖所示;
3.1 新建項(xiàng)目進(jìn)入項(xiàng)目管理界面,點(diǎn)擊右側(cè)"+新增項(xiàng)目"按鈕可新建項(xiàng)目,如下圖所示:
項(xiàng)目屬性說明:
項(xiàng)目名稱:項(xiàng)目的名稱; 項(xiàng)目描述:項(xiàng)目的描述信息; 訪問權(quán)限:"公開"權(quán)限,表示所有人可操作;"私有"權(quán)限,表示只有管理員或者項(xiàng)目成員可以操作(功能自測(cè)中,即將推送); 跟地址-線上環(huán)境:項(xiàng)目線上環(huán)境跟地址,項(xiàng)目中的API共用該跟地址; 跟地址-預(yù)發(fā)布環(huán)境:項(xiàng)目預(yù)發(fā)布環(huán)境跟地址; 跟地址-測(cè)試環(huán)境:項(xiàng)目測(cè)試環(huán)境跟地址; 版本:項(xiàng)目的版本信息;3.2 更新項(xiàng)目
進(jìn)入項(xiàng)目管理界面,點(diǎn)擊項(xiàng)目右側(cè)的"編輯"按鈕可更新項(xiàng)目信息,如下圖所示;
3.3 刪除項(xiàng)目進(jìn)入項(xiàng)目管理界面,點(diǎn)擊項(xiàng)目右側(cè)的"刪除"按鈕可刪除項(xiàng)目信息;注意,項(xiàng)目中存在API時(shí)不允許刪除;
四、API管理在項(xiàng)目管理界面,點(diǎn)擊項(xiàng)目右側(cè)的"進(jìn)入項(xiàng)目"按鈕,可進(jìn)入接口管理界面,如下圖所示:
4.1 API分組管理新增API分組
如下圖,點(diǎn)擊"左側(cè)接口分組區(qū)域"右上角的"+"按鈕,可新增AIP接口分組;(點(diǎn)擊"全部"將會(huì)展示項(xiàng)目中所有分組下的接口;"默認(rèn)分組"為系統(tǒng)分組,不允許刪除;)
接口分組屬性說明:
分組名稱:分組的名稱 分組排序:分組的排序順序,數(shù)字類型,值越小越靠前;
更新API分組
在"左側(cè)接口分組區(qū)域",點(diǎn)擊對(duì)應(yīng)的API分組,右側(cè)將會(huì)展示該分組下API接口列表;如下圖,點(diǎn)擊接口列表頂部的"編輯分組"按鈕(新增的API分組才會(huì)有該功能),可修改API分組信息;
刪除API分組
在"左側(cè)接口分組區(qū)域",點(diǎn)擊對(duì)應(yīng)的API分組,右側(cè)將會(huì)展示該分組下API接口列表;點(diǎn)擊接口列表頂部的"刪除分組"按鈕(新增的API分組才會(huì)有該功能),可修改API分組信息;
4.2 API管理新增API
如下圖,在API接口管理界面,點(diǎn)擊接口列表頂部的"新增接口"按鈕,可進(jìn)入新增接口界面;
在新增接口界面,如下圖所示,可以設(shè)置接口的API狀態(tài)、請(qǐng)求方法、請(qǐng)求URL、請(qǐng)求頭部、請(qǐng)求參數(shù)、響應(yīng)結(jié)果、響應(yīng)結(jié)果格式、響應(yīng)結(jié)果參數(shù)、API備注等等信息;
API屬性說明:
基礎(chǔ)信息: 接口分組:接口所屬的分組; 接口狀態(tài):接口的狀態(tài),在接口列表中,啟用狀態(tài)接口用綠色圓圈標(biāo)識(shí),維護(hù)狀態(tài)接口用黃色圓圈標(biāo)識(shí),廢棄狀態(tài)接口用灰色圓圈標(biāo)識(shí); 請(qǐng)求方法:請(qǐng)求方法,如POST、GET等; 接口URL:接口請(qǐng)求的URL地址,注意此處為相對(duì)地址,跟地址從所屬項(xiàng)目的跟地址屬性上獲取; 接口名稱:接口的名稱; 請(qǐng)求頭部:同一接口支持設(shè)置多個(gè)請(qǐng)求頭部; 頭部標(biāo)簽:請(qǐng)求頭部的類型,如Accept-Encoding; 頭部?jī)?nèi)容:請(qǐng)求頭部的數(shù)據(jù),如Accept-Encoding頭部標(biāo)簽的頭部?jī)?nèi)容UTF-8; 請(qǐng)求參數(shù):同一接口支持設(shè)置多個(gè)請(qǐng)求參數(shù); 是否必填:該參數(shù)是否必填; 參數(shù)類型:該參數(shù)的數(shù)據(jù)類型,如STRING; 參數(shù)名稱:參數(shù)的名稱; 參數(shù)說明:參數(shù)的說明; 響應(yīng)結(jié)果:分別支持設(shè)置 "成功響應(yīng)結(jié)果" 和 "失敗響應(yīng)結(jié)果",作為接口響應(yīng)數(shù)據(jù)的參考; 響應(yīng)數(shù)據(jù)類型(MIME):響應(yīng)結(jié)果類型,如JSON、XML等; 響應(yīng)結(jié)果數(shù)據(jù):響應(yīng)結(jié)果的數(shù)據(jù),如響應(yīng)結(jié)果類型為JSON時(shí)可設(shè)置響應(yīng)結(jié)果數(shù)據(jù)為一段JSON數(shù)據(jù); 響應(yīng)結(jié)果參數(shù):對(duì)接口"響應(yīng)結(jié)果"中參數(shù)的補(bǔ)充說明,如響應(yīng)結(jié)果類型為JSON時(shí),可在此處一一列出JSON各個(gè)字段的參數(shù)信息; 是否非空:該參數(shù)是否可能為空; 參數(shù)類型:該參數(shù)的數(shù)據(jù)類型,如STRING; 參數(shù)名稱:參數(shù)的名稱; 參數(shù)說明:參數(shù)的說明; 接口備注:markdown方式的接口備注;
更新API
在API接口管理界面,點(diǎn)擊接口右側(cè)的"更新接口圖標(biāo)"按鈕,可進(jìn)入更新接口界面;
刪除API
在API接口管理界面,點(diǎn)擊接口右側(cè)的"刪除接口圖標(biāo)"按鈕,可刪除接口數(shù)據(jù);
4.3 API-Mock新增Mock數(shù)據(jù)
在API接口管理界面,點(diǎn)擊接口名稱,進(jìn)入"接口詳情頁",在接口詳情頁的"Mock數(shù)據(jù)"模塊右上角點(diǎn)擊"+Mock數(shù)據(jù)"按鈕,可新增Mock數(shù)據(jù);
Mock數(shù)據(jù)屬性說明:
數(shù)據(jù)類型(MIME):響應(yīng)結(jié)果類型,如JSON、XML等; 結(jié)果數(shù)據(jù):響應(yīng)結(jié)果的數(shù)據(jù),如響應(yīng)結(jié)果類型為JSON時(shí)可設(shè)置響應(yīng)結(jié)果數(shù)據(jù)為一段JSON數(shù)據(jù);
更新Mock數(shù)據(jù)
在"接口詳情頁"的"Mock數(shù)據(jù)"模塊,點(diǎn)擊Mock數(shù)據(jù)列表右側(cè)的"修改"按鈕,可修改Mock數(shù)據(jù);
刪除Mock數(shù)據(jù)
在"接口詳情頁"的"Mock數(shù)據(jù)"模塊,點(diǎn)擊Mock數(shù)據(jù)列表右側(cè)的"刪除"按鈕,可刪除Mock數(shù)據(jù);
運(yùn)行Mock數(shù)據(jù)
在"接口詳情頁"的"Mock數(shù)據(jù)"模塊,點(diǎn)擊Mock數(shù)據(jù)列表右側(cè)的"運(yùn)行"按鈕,可運(yùn)行Mock數(shù)據(jù);
系統(tǒng)將會(huì)為每一條Mock數(shù)據(jù)生成一個(gè)唯一的Mock連接,訪問該連接將會(huì)按照設(shè)置的數(shù)據(jù)類型如JSON返回對(duì)應(yīng)格式的Mock數(shù)據(jù),如下圖所示;
API-測(cè)試
進(jìn)入"接口詳情頁",點(diǎn)擊"Test歷史"模塊右上角的"+接口測(cè)試"按鈕,可進(jìn)入"接口測(cè)試界面",
該界面將會(huì)自動(dòng)初始化接口URL(測(cè)試界面支持選擇運(yùn)行環(huán)境,將會(huì)自動(dòng)生成不同環(huán)境的完整URL連接)和參數(shù)等信息。
只需要填寫測(cè)試的參數(shù)值,點(diǎn)擊下方"運(yùn)行"按鈕,即可發(fā)起一次接口請(qǐng)求,請(qǐng)求結(jié)果將會(huì)在下方顯示出來:
保存Test歷史
在"接口測(cè)試界面",在進(jìn)行接口測(cè)試后, 點(diǎn)擊下方"保存"按鈕將會(huì)把本次測(cè)試數(shù)據(jù)(接口URL,測(cè)試參數(shù)等信息)保存下來。
在"接口詳情頁"的"Test歷史"模塊可查看所有的接口測(cè)試歷史記錄。點(diǎn)擊一次測(cè)試記錄右側(cè)的"運(yùn)行"按鈕,將會(huì)進(jìn)入到本次測(cè)試記錄對(duì)應(yīng)的接口測(cè)試界面,還原當(dāng)時(shí)測(cè)試時(shí)使用的測(cè)試數(shù)據(jù);
刪除Test歷史
在"接口詳情頁"的"Test歷史"模塊,點(diǎn)擊測(cè)試歷史記錄右側(cè)的"刪除"按鈕可刪除本條記錄;
五、用戶管理 5.1、新增用戶進(jìn)入用戶管理界面,點(diǎn)擊右上角"+新增用戶"按鈕,可添加用戶信息;
用戶屬性說明:
登錄賬號(hào):用戶的登錄賬號(hào); 登錄密碼:用戶的登錄密碼; 用戶類型: 普通用戶:只允許操作公開項(xiàng)目,或者自己擁有項(xiàng)目權(quán)限的私有項(xiàng)目; 超級(jí)管理員:擁有所有項(xiàng)目的操作權(quán)限; 真實(shí)姓名:用戶的真實(shí)姓名;5.2、更新用戶
進(jìn)入用戶管理界面,點(diǎn)擊用戶列表頁中用戶右側(cè)的"編輯"按鈕可編譯用戶信息;
5.3、刪除用戶進(jìn)入用戶管理界面,點(diǎn)擊用戶列表頁中用戶右側(cè)的"刪除"按鈕可刪除用戶信息;
六、版本更新日志 6.1 版本 V1.0.0,新特性1、極致簡(jiǎn)單:交互簡(jiǎn)潔,一分鐘上手;
2、項(xiàng)目隔離:API以項(xiàng)目為維度進(jìn)行拆分隔離;
3、分組管理:?jiǎn)蝹€(gè)項(xiàng)目?jī)?nèi)的API支持自定義分組進(jìn)行管理;
4、標(biāo)記星級(jí):支持標(biāo)注API星級(jí),標(biāo)記后優(yōu)先展示;
5、API管理:創(chuàng)建、更新和刪除API;
6、API屬性完善:支持設(shè)置豐富的API屬性如:API狀態(tài)、請(qǐng)求方法、請(qǐng)求URL、請(qǐng)求頭部、請(qǐng)求參數(shù)、響應(yīng)結(jié)果、響應(yīng)結(jié)果格式、響應(yīng)結(jié)果參數(shù)、API備注等等;
7、markdown:支持為API添加markdown格式的備注信息;
8、Mock:支持為API定義Mock數(shù)據(jù)并制定數(shù)據(jù)響應(yīng)格式,從而快速提供Mock接口,加快開發(fā)進(jìn)度;
9、在線測(cè)試:支持在線對(duì)API進(jìn)行測(cè)試并保存測(cè)試數(shù)據(jù),提供接口測(cè)試效率;
6.12 版本 V1.0.1 特性(Coding)1、項(xiàng)目權(quán)限:支持對(duì)項(xiàng)目設(shè)置權(quán)限,擁有權(quán)限才允許操作項(xiàng)目中API;
TODO LIST1、項(xiàng)目權(quán)限:支持對(duì)項(xiàng)目設(shè)置權(quán)限,擁有權(quán)限才允許操作項(xiàng)目中API;
2、API歷史版本:支持對(duì)API修改歷史版本進(jìn)行對(duì)比,版本回溯等操作;
七、其他 7.1 報(bào)告問題XXL-API托管在Github上,如有問題可在 ISSUES 上提問,也可以加入上文技術(shù)交流群;
7.2 接入登記(登記僅為了推廣,產(chǎn)品開源免費(fèi))更多接入公司,歡迎在github 登記
支持的話可以掃一掃,支持 XXL系列 的建設(shè)。文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://specialneedsforspecialkids.com/yun/66951.html
新特性 1、接口成功/失敗響應(yīng)結(jié)果支持JSON格式化校驗(yàn)與展示,方便數(shù)據(jù)查看; 2、項(xiàng)目遷移至 springboot 版本; 3、docker支持:提供 Dockerfile 方便快速構(gòu)建docker鏡像; 4、項(xiàng)目下存在接口時(shí)拒絕刪除,防止數(shù)據(jù)誤刪除; 5、接口分組刪除問題修復(fù); 6、接口在線測(cè)試功能對(duì)于響應(yīng)狀態(tài)碼為302的請(qǐng)求未能正確展示Location問題修復(fù); 簡(jiǎn)介 XXL-API 是...
摘要:管理系統(tǒng)為任何市場(chǎng)提供一個(gè)完整的規(guī)范標(biāo)準(zhǔn)并使其能夠有效運(yùn)行。在以下部分中,我們將探討在生態(tài)系統(tǒng)中發(fā)揮作用的技術(shù)和業(yè)務(wù)考慮因素,并討論創(chuàng)建和管理有效市場(chǎng)的關(guān)鍵步驟。專業(yè)和平臺(tái)開發(fā)人員為該平臺(tái)創(chuàng)建的服務(wù)將在電信公司的應(yīng)用商店中發(fā)布。 API市場(chǎng)關(guān)鍵要點(diǎn) 各個(gè)行業(yè)的公司正在尋找通過外部API擴(kuò)展服務(wù)來塑造數(shù)字業(yè)務(wù)的方法。然而,要獲得API的真正好處,是需要超越基本的API管理,再到創(chuàng)建API...
摘要:而當(dāng)企業(yè)只是將系統(tǒng)與系統(tǒng)之間的調(diào)用使用的方式進(jìn)行訪問時(shí)使用網(wǎng)關(guān)對(duì)調(diào)用進(jìn)行管理,那么網(wǎng)關(guān)起到的就是服務(wù)治理的作用。另外很多企業(yè)因?yàn)樽陨硇畔踩脑颍荒苁褂猛饩W(wǎng)公有網(wǎng)的網(wǎng)關(guān)服務(wù),這樣就只有選擇私有云的方案了。 showImg(https://segmentfault.com/img/bVbsVBA?w=255&h=255); 前言 「 API網(wǎng)關(guān) 」是任何微服務(wù)架構(gòu)的重要組成部分。有了...
摘要:用友云平臺(tái)基于云原生架構(gòu)的基礎(chǔ),賦能所有云成為真正的云架構(gòu)平臺(tái)。用友云平臺(tái)上已經(jīng)運(yùn)營(yíng)著財(cái)務(wù)采購(gòu)支付等領(lǐng)域云,及政務(wù)能源建筑等行業(yè)云。用友云平臺(tái)中有一個(gè)開發(fā)者中心,是云原生的最好體現(xiàn)。 數(shù)字化經(jīng)濟(jì)的出現(xiàn),企業(yè)需要通過新技術(shù)實(shí)現(xiàn)數(shù)字化轉(zhuǎn)型,完成企業(yè)管理和業(yè)務(wù)模式變革。而云計(jì)算是數(shù)字化中尤為重要且能夠更快實(shí)現(xiàn)的技術(shù)手段。真正的云應(yīng)用必須是基于云原生架構(gòu)的,PaaS是一個(gè)重要的步驟,因?yàn)檫@是云...
摘要:與或等流行工具結(jié)合或集成在當(dāng)今的混合云管理提供商中很常見。如果中止混合云管理合同,那么它只是策略的一部分,而加入現(xiàn)有資源則需要模板轉(zhuǎn)換為混合云管理格式。實(shí)際上,組織不必選擇最好的混合云管理產(chǎn)品。混合云管理(HCM)市場(chǎng)的發(fā)展如今有些停滯不前,但最近這一切發(fā)生了變化。很多企業(yè)開始解決云計(jì)算管理挑戰(zhàn),在采用云計(jì)算策略的企業(yè)中,超過一半的基礎(chǔ)設(shè)施決策者正在積極監(jiān)控使用情況,并創(chuàng)建有效的云計(jì)算策略。...
閱讀 3533·2021-11-18 13:22
閱讀 2546·2021-09-23 11:53
閱讀 714·2019-08-30 13:17
閱讀 1338·2019-08-30 13:12
閱讀 890·2019-08-29 15:43
閱讀 1090·2019-08-29 12:53
閱讀 2825·2019-08-26 18:27
閱讀 1493·2019-08-26 11:52