企業自建API接口開放平台的解決方案
根據百度百科的定義,
開放平台(Open Platform) 在軟體行業和網絡中,開放平台是指軟體系統通過公開其應用程式程式設計接口(API)或函數(function)來使外部的程式可以增加該軟體系統的功能或使用該軟體系統的資源,而不需要更改該軟體系統的源代碼。
-- 百度百科
不管是網際網路平台,還是傳統的企業,都可以從建構企業接口開放平台中擷取到價值和作用。一方面,可以滿足目前下遊客戶、合作夥伴對于API接口、資料共享、系統對接的開發需求;另一方面,可以培育和搭建基于自己産品和業務的接口開放平台,積累開發者經驗和築建開發者生态。
YesApi接口大師(5合1)
YesApi 接口大師(原名:PhalApi Pro 專業版),是一款企業級API接口管理平台。它通過低代碼、可視化配置方式,幫助企業快速搭建API接口開放平台,讓企業可以即刻管理API接口資産、對外開放API接口、以及支援API低代碼開發。
簡而言之,接口大師是一套快速研發、管理和開放API接口的軟體産品、源代碼和解決方案。除了有源代碼,還有開發文檔,以及完善的産品軟體系統。
接口大師5合1的産品能力,主要包括有:
1、OpenAPI開放接口:提供給用戶端、第三方和内部系統調用的API接口。
2、Docs線上接口文檔:自動生成的接口文檔,支援線上測試、
3、Platform開放平台:提供給内部或外部開發者使用的平台。
4、Admin管理背景:提供給内部管理者使用的總背景。
5、Wiki技術文檔:整的二次技術開發手冊、使用手冊。

一鍵遷移Eolink/Swagger内部接口
Swagger接口導入
如果原來是使用Swagger維護接口文檔的,如果需要變成開放接口,可以進入Admin管理背景,進行線上導入。
Eolink接口導入
如果原來是使用Eolink維護内部接口文檔的,可以使用腳本指令方式進行批量導入、和增量遷移。可以批量遷移幾百個甚至上千個API接口。遷移方案是:
- 提供腳本指令,支援一鍵導入,可重複操作
- 通過網關方式,連接配接原來智慧API
- 為簡化開放接口使用,推薦查詢類用GET,操作類用POST,不建議使用 PUT/DELETE
- 自動生成的API代碼不建議修改,預留人工二次開發的接口
管理API接口資産
API接口導入後,即可在Admin管理背景進行API接口資産的管理,包括但不限于:接口權限配置設定、接口請求日記、接口監控、接口流量統計、接口套餐配置、接口測試。
低代碼API開發
使用接口大師,除了可以批量一鍵遷移API接口,還可以快速生成資料庫的API接口(能寫SQL語句就能低代碼開放API接口)。
首先,你可以在管理背景配置多個資料庫。
随後,你可以線上生成資料庫API接口,選擇資料庫、選擇資料庫表,并進行SQL語句編寫和調整、接口測試。
最後,釋出你的資料API接口。
對外開放API接口
概括來講,接口大師,一方面可以幫助你快速低代碼開發API接口,也能幫你快速一鍵遷移AIP接口,同時還能通過可視化和配置化的方式輕松管理你的API接口資産和接口文檔。
更重要,也是最重要的是,接口大師能夠幫助企業快速、輕松對外開放API接口。
這時,我們需要給外部的開發者提供三個核心價值的産品:OpenAPI、線上接口文檔以及一個開放平台。
OpenAPI線上接口文檔,是開發者檢視和使用API接口必備的資料。在接口大師,接口文檔是實時根據源代碼自動生成的,不需要人工額外維護,既減少了維護成本,又能實時100%保證接口文檔的同步和一緻性。
開發者可以在開放平台,進行自主注冊和登入,以及檢視自己的API接口。
最後,開發者要開通賬号後,就可以調用和使用OpenAPI開放接口。
技術開發文檔
Wiki技術開發文檔,是為了友善企業能夠二次開發而提供的重要資料。包括了安裝、産品使用、開發文檔教程和重要配置說明等。
接口大師 v3.15 版本釋出與更新的内容
PhalApi專業版 3.15.0 (2022-08)
- 1、增加接口監控,可以追加檢視API接口的響應時間和分析、監控
- 2、首頁UI微調整,更加簡潔、美觀、大氣
- 3、建立接口時,支援快速建立表
- 4、Admin管理背景菜單結構調整,更加清晰明了
- 5、建立接口時,也支援【儲存并釋出】
- 6、修複 接口大師v3.13無法可視化安裝,提示資料庫錯誤
- 7、在接口請求日記追加接口參數的記錄,可選,預設開啟
- 8、接口計劃任務更新:1)定時修複運作異常的任務;2)執行中的任務時間最大調整成10分鐘;3)修複開啟調試模式下接口結果寫入過長問題;4)調整更新使用說明;5)去掉不必要的MQ分表;6)result字段改成text類型;
- 9、提供手動執行接口的指令方式,提供另一種直接、準确執行接口計劃任務的原始方式,并更新技術文檔 3.6 接口計劃任務。
- 10、開發者使用者建立工單後,支援通知推送(企業微信+釘釘)
如何更新到接口大師v3.15 新版本?
在擷取到最新版v3.15.0源代碼,源代碼後,本次版本更新的主要内容有:
注意!更新前,請注意原有的代碼備份!!
1、替換./public/platform目錄,更新Platform開放平台的編譯包代碼(如果原來已經改動Platform源代碼,需要合并源碼後再編譯打包更新,可以使用git的分支合并進行新版本的對比和更新)
2、替換./public/admin目錄,更新Admin管理背景的編譯包代碼(如果原來已經改動Admin源代碼,需要合并源碼後再編譯打包更新,可以使用git的分支合并進行新版本的對比和更新)
3、PHP源代碼更新
對比并替換./src/base目錄,對比并替換./src/admin目錄,對比并替換./src/platform目錄,對比并替換./public/api目錄。可以使用git的分支合并進行新版本的對比和更新。
4、資料庫更新
請見
./data/phalapi_pro_v3.15.0.sql 資料庫檔案變更,并執行。
5、config檔案目錄更新
6、bin指令腳本目錄更新