【國產(chǎn)】API接口管理平臺的產(chǎn)品設(shè)計與搭建講解
PhalApi Pro (發(fā)音：π框架專業(yè)版)，是一款國產(chǎn)企業(yè)級API接口管理平臺，可以零代碼、快速搭建API接口開發(fā)平臺、接口開放平臺、接口管理平臺。基于PhalApi開源接口開發(fā)框架，通過低代碼可視化配置方式幫助企業(yè)快速搭建接口開放平臺和管理API接口。
演示環(huán)境：
https://www.yesx2.com/
整體產(chǎn)品設(shè)計和搭建流程介紹：
前言
在前面文章有介紹，關(guān)于API接口開放平臺的搭建介紹，本文是為了配套接口開放平臺而設(shè)計搭建相呼應(yīng)的另一半 —— 國產(chǎn)API接口管理平臺的產(chǎn)品設(shè)計與搭建。
首先，第一步，先來厘清楚，我們需要一個怎樣的接口管理平臺？分為四點考慮：
1、使用場景有哪些？接口管理平臺的定位是什么？
2、主流程是怎樣的？接口管理平臺的上游、下游，以及使用人群有哪些？
3、對于內(nèi)部的管理，整個接口管理平臺的使用三步曲是怎樣的？
4、包括最后技術(shù)架構(gòu)方面的考慮，以及高并發(fā)、水平擴容的技術(shù)方案。
簡而言之，使用場景有：用于搭建API服務(wù)市場、接口開放平臺、數(shù)據(jù)中臺、OpenAPI、PaaS服務(wù)、Serverless服務(wù)等；接口管理平臺在整個主流程中是處理接口資源服務(wù)提供方，為開發(fā)者提供API接口調(diào)用及服務(wù)；而使用的三步曲則是：API開發(fā)、API管理和API服務(wù)；技術(shù)架構(gòu)是采用Linux+PhalApi+MySQL數(shù)據(jù)庫+Nginx負載均衡的方式和Vue前后端分離開發(fā)。
以下是參考的技術(shù)架構(gòu)圖，
首先，你需要一個研發(fā)團隊。
其次，站在產(chǎn)品經(jīng)理和項目經(jīng)理的角度，分別需要產(chǎn)品經(jīng)理進行產(chǎn)品腦圖的設(shè)計、以及項目經(jīng)理對整個平臺項目的功能清單拆解和開發(fā)排期。
最后，就是具體的PRD原型設(shè)計和具體的開發(fā)編碼，最后上線交付使用。
關(guān)于接口管理平臺的產(chǎn)品腦圖設(shè)計，這里再附上一次腦圖：
以及對應(yīng)的產(chǎn)品功能清單表格：
| 管理員中心 |
管理員登錄、修改密碼、退出登錄、修改個人資料 |
| 后臺首頁 |
概況統(tǒng)計（待審核應(yīng)用、全部賬號、今日接口請求、全部接口）、接口流量統(tǒng)計、近期歷史統(tǒng)計、昨日活躍 App |
| API 接口計費 |
接口流量套餐：支持試套餐和付費套餐，接口流量套餐列表、添加套餐、修改套餐、刪除套餐，支持組合套餐 |
| 開發(fā)者余額充值 |
充值審核：后臺進行開發(fā)者余額審核； |
| API 接口管理 |
低代碼接口開發(fā)：自動生成 API 接口源代碼，接口管理、在線開發(fā)、發(fā)布、自動生成，支持網(wǎng)關(guān)接口、數(shù)據(jù)庫接口、普通接口生成模式、支持 GET/POST 方法設(shè)置，生成數(shù)據(jù) API 接口時可以選擇數(shù)據(jù)庫和數(shù)據(jù)庫表，同時支持 簡易代碼模式和完整代碼模式； |
| 接口權(quán)限 |
接口權(quán)限分配：接口權(quán)限分配，自動檢測 API 接口資產(chǎn)，支持快速按配置的開發(fā)者角色進行接口權(quán)限分配，列表查看 |
| 接口測試 |
接口測試：自動化接口測試，接口測試、全局 access_token 配置、搜索用例、添加新用例、運行用例、編輯查看用例、測試報告 |
| 接口監(jiān)控 |
實時接口流量統(tǒng)計：接口流量統(tǒng)計拆線疊加圖，支持日期范圍搜索，支持查看付費接口、試用接口、普通接口、扣費失敗接口請求統(tǒng)計 接口監(jiān)控：可以查看 API 接口的響應(yīng)時間和分析、監(jiān)控 |
| 賬號管理 |
賬號列表：賬號搜索、賬號列表、賬號修改、賬號刪除 |
| 應(yīng)用管理 |
應(yīng)用管理：應(yīng)用列表、應(yīng)用搜索、應(yīng)用審核、應(yīng)用編輯、應(yīng)用刪除，禁用應(yīng)用，查看應(yīng)用的接口權(quán)限 |
| 工單管理 |
工單列表：工單列表、工單過濾、工單回復(fù)和處理、工單詳情查看 |
| 素材庫 |
文件管理：文件列表、文件搜索 |
| 配置管理 |
配置管理：配置列表、配置編輯、配置刪除、配置搜索 |
| 異步消息隊列管理 |
主題訂閱管理：發(fā)布新消息主題，進行增刪改查，以及推送次數(shù)統(tǒng)計； |
| 計劃任務(wù) |
計劃任務(wù)列表：任務(wù)列表、開啟 / 關(guān)閉任務(wù)、刪除任務(wù)、運行結(jié)果查看 |
| 數(shù)據(jù)庫管理 |
數(shù)據(jù)庫配置：支持 MySQL 、 SQL Server 等動態(tài)數(shù)據(jù)庫源管理和配置、使用， DI 數(shù)據(jù)庫服務(wù)使用延時初始化，保證數(shù)據(jù)庫連接性能 、測試數(shù)據(jù)庫連接 |
| 信息中心 |
文章列表：文章的列表展示，檢索，前臺訪問、編輯和刪除等操作； |
| 統(tǒng)計 |
應(yīng)用歷史統(tǒng)計：統(tǒng)計每個應(yīng)用每日的匯總數(shù)據(jù)，支持查看付費接口、試用接口、普通接口、扣費失敗接口請求統(tǒng)計 |
| 權(quán)限管理 |
管理后臺權(quán)限分配： Admin 管理后臺的權(quán)限分配、管理員角色等級、添加 / 刪除新菜單操作、權(quán)限分配與取消 |
具體的PRD原型設(shè)計，則根據(jù)你的平臺定位及功能清單展開。
如何使用接口管理平臺？首頁模塊，從上往下，依次有：頂部網(wǎng)站菜單（含 管理后臺，可自行隱藏）、接口搜索、接口分類、Banner輪播圖、信息文章發(fā)布、三個廣告位的運營、優(yōu)惠套餐推薦、熱門接口（分為：免費接口/付費接口/熱門接口）。
以下為截圖長圖（手機版查看時，避免超了流量），
使用1：登錄管理后臺以及管理后臺的首頁功能介紹
使用2：核心的使用，包括開發(fā)者賬號及開發(fā)者應(yīng)用的管理。
概念解釋：開發(fā)者是使用開放平臺的人；而最終調(diào)用API接口的對象不是開發(fā)者本人，而是開發(fā)者開發(fā)出來的客戶端或應(yīng)用。故而需要在開發(fā)者名下設(shè)計他的多個應(yīng)用，方便進行接口權(quán)限的分配和管理。
使用3：【偏技術(shù)】API低代碼開發(fā)、一鍵發(fā)布、自動生成API接口文檔；API接口權(quán)限分配和管理，以及接口權(quán)限的申請。
API接口低代碼的開發(fā)包括從接口生成、接口在線調(diào)試、接口文檔的自動生成和API接口的在線調(diào)試，一氣呵成。
以下是自動生成API在線接口文檔的完整截圖，非常方便不懂技術(shù)開發(fā)的人員使用（長圖）。
對于生成和開發(fā)且發(fā)布后的API接口權(quán)限，分為兩種接口權(quán)限管理模式。一種是在管理后臺預(yù)設(shè)好每個開發(fā)者角色擁有哪些接口權(quán)限，這樣一旦新的開發(fā)者注冊后就可以自動獲得對應(yīng)的接口能力；另一種模式是由注冊的新開發(fā)者用戶主動申請需要哪些接口權(quán)限，然后在管理后臺再進行人工審核。
除此之外，接口管理平臺還應(yīng)搭載數(shù)據(jù)庫連接的能力，包括常用的數(shù)據(jù)庫：MySQL、PostgreSQL數(shù)據(jù)庫、SQL Server數(shù)據(jù)庫、國產(chǎn)高斯數(shù)據(jù)庫、和Oracle數(shù)據(jù)庫等，以及數(shù)據(jù)庫存儲過程的管理能力。
使用4：【偏運營】站點全局配置、后臺權(quán)限分配、開放平臺權(quán)限分配、報表統(tǒng)計、訂單管理等。
運營分為兩條主線，一條主線是常規(guī)的站點運營，包括：基本的全局站點配置，包括網(wǎng)站備案號、網(wǎng)站名稱和Logo圖標(biāo)、網(wǎng)站統(tǒng)計代碼和SEO優(yōu)化等；和平臺菜單權(quán)限的分配。另一條線是運營統(tǒng)計報表，包括在用戶側(cè)、GMV收入側(cè)和接口實際每天調(diào)用消耗側(cè)，這三個最具有代表性維度的統(tǒng)計和分析。
關(guān)于作者
黃禪宗 dogstar，果創(chuàng)科技CEO、多家企業(yè)CTO、前唯品會高級開發(fā)工程師，PhalApi開源框架作者，著有《良質(zhì)!》等電子書，YesApi果創(chuàng)云創(chuàng)始人、YesDev項目管理創(chuàng)始人，海軍退役士兵，畢業(yè)于華南師范大學(xué)。深耕軟件研發(fā)，喜歡每天分享技術(shù)干貨。