碼好這款A(yù)PI管理神器,實(shí)現(xiàn)企業(yè)高效協(xié)作!
- 時間:2023-08-09
- 來源:遠(yuǎn)光軟件
隨著數(shù)字技術(shù)的發(fā)展,應(yīng)用程序微服務(wù)化、移動化成為當(dāng)下趨勢,各類企業(yè)普遍通過調(diào)用API(應(yīng)用程序接口)來高效、低成本、快速地獲取數(shù)據(jù)和技術(shù)能力,API開發(fā)模式也走向標(biāo)準(zhǔn)化和體系化。
但在使用API接口過程中,同時也會產(chǎn)生一系列問題,如:
x 多系統(tǒng)數(shù)據(jù)不互通,API設(shè)計者與前后端開發(fā)和測試人員之間存在大量重復(fù)的工作;
x 多系統(tǒng)采用單機(jī)離線使用為主的方式使得團(tuán)隊間協(xié)作困難、費(fèi)時費(fèi)力;
x 每次變更都需要多方在多套系統(tǒng)中手動修改數(shù)據(jù),難以保證數(shù)據(jù)一致性。
為此,遠(yuǎn)光軟件推出一款集API設(shè)計、開發(fā)、測試于一體的一體化協(xié)作平臺APIStore,實(shí)現(xiàn)多人多角色的協(xié)作,解決多個系統(tǒng)間的數(shù)據(jù)同步問題,并開放接口,可供其他外部用戶調(diào)試、調(diào)用,同時支持將API投放至市場供消費(fèi)者調(diào)試、使用。只要定義好接口文檔,接口調(diào)試、數(shù)據(jù)Mock即可直接使用,無需再次定義程序。
API上報方式
APIStore目前支持三種方式將API上報:swagger自動上報、手動錄入和內(nèi)部產(chǎn)品間推送。
基本流程
服務(wù)提供方在APIStore里設(shè)計好API后,將API發(fā)布至API市場,消費(fèi)方經(jīng)過調(diào)試后可以消費(fèi)調(diào)用API,實(shí)現(xiàn)API統(tǒng)一開放和管理。同時API市場匯總整理了熱門的開放API接口,可以快速搜索到合適接口。
在API市場里消費(fèi)者可查看API文檔詳細(xì)信息,包括請求方式、請求參數(shù)、請求示例、響應(yīng)示例等。消費(fèi)API之前可對Mock API等進(jìn)行調(diào)試,確保API的準(zhǔn)確性。之后便可以對已發(fā)布的API發(fā)起消費(fèi)申請,由API管理員和提供方審批,審批通過即消費(fèi)成功。此外,管理員還具備協(xié)同成員管理、API分類標(biāo)簽管理、熔斷限流管理、網(wǎng)關(guān)黑白名單等功能。
應(yīng)用價值
遠(yuǎn)光API協(xié)作一體化平臺對于前端人員來說,可以通過后端分享的接口文檔地址,清晰的查看規(guī)范的接口文檔,配合后端給定的Mock地址,先行進(jìn)入研發(fā)狀態(tài);對于后端人員來說,平臺不僅是一個接口調(diào)試的工具,更是一個接口文檔快速生成工具;對于測試人員來說,可以進(jìn)行常規(guī)的接口調(diào)試功能和接口的流程化測試;對于團(tuán)隊來說,可以對項目接口文檔進(jìn)行規(guī)范管理,解決人員流動帶來的文檔丟失、不易查找等難題,大大提升團(tuán)隊的研發(fā)效率!