【国产接口管理平台】PhalApi Pro (π框架专业版)
PhalApi Pro (发音:π框架专业版),是一款国产企业级API接口管理平台,可以零代码、快速搭建API接口开发平台、接口开放平台、接口管理平台。基于PhalApi开源接口开发框架,通过低代码可视化配置方式帮助企业快速搭建接口开放平台和管理API接口。
演示环境:
接口大师[旗舰版演示]
整体产品设计和搭建流程介绍:
前言
在前面文章有介绍,关于API接口开放平台的搭建介绍,本文是为了配套接口开放平台而设计搭建相呼应的另一半 —— 国产API接口管理平台的产品设计与搭建。
接口管理平台的需求、定位与项目分析
首先,第一步,先来厘清楚,我们需要一个怎样的接口管理平台?分为四点考虑:
1、使用场景有哪些?接口管理平台的定位是什么?
2、主流程是怎样的?接口管理平台的上游、下游,以及使用人群有哪些?
3、对于内部的管理,整个接口管理平台的使用三步曲是怎样的?
4、包括最后技术架构方面的考虑,以及高并发、水平扩容的技术方案。
简而言之,使用场景有:用于搭建API服务市场、接口开放平台、数据中台、OpenAPI、PaaS服务、Serverless服务等;接口管理平台在整个主流程中是处理接口资源服务提供方,为开发者提供API接口调用及服务;而使用的三步曲则是:API开发、API管理和API服务;技术架构是采用Linux+PhalApi+MySQL数据库+Nginx负载均衡的方式和Vue前后端分离开发。
以下是参考的技术架构图,
如何设计和搭建你的接口管理平台?
首先,你需要一个研发团队。
其次,站在产品经理和项目经理的角度,分别需要产品经理进行产品脑图的设计、以及项目经理对整个平台项目的功能清单拆解和开发排期。
最后,就是具体的PRD原型设计和具体的开发编码,最后上线交付使用。
关于接口管理平台的产品脑图设计,这里再附上一次脑图:
以及对应的产品功能清单表格:
管理员中心 | 管理员登录、修改密码、退出登录、修改个人资料 |
后台首页 | 概况统计(待审核应用、全部账号、今日接口请求、全部接口)、接口流量统计、近期历史统计、昨日活跃App |
API接口计费 | 接口流量套餐:支持试套餐和付费套餐,接口流量套餐列表、添加套餐、修改套餐、删除套餐,支持组合套餐 |
开发者余额充值 | 充值审核:后台进行开发者余额审核; |
API接口管理 | 低代码接口开发:自动生成API接口源代码,接口管理、在线开发、发布、自动生成,支持网关接口、数据库接口、普通接口生成模式、支持GET/POST方法设置,生成数据API接口时可以选择数据库和数据库表,同时支持 简易代码模式和完整代码模式; |
接口权限 | 接口权限分配:接口权限分配,自动检测API接口资产,支持快速按配置的开发者角色进行接口权限分配,列表查看 |
接口测试 | 接口测试:自动化接口测试,接口测试、全局access_token配置、搜索用例、添加新用例、运行用例、编辑查看用例、测试报告 |
接口监控 | 实时接口流量统计:接口流量统计拆线叠加图,支持日期范围搜索,支持查看付费接口、试用接口、普通接口、扣费失败接口请求统计 接口监控:可以查看API接口的响应时间和分析、监控 |
账号管理 | 账号列表:账号搜索、账号列表、账号修改、账号删除 |
应用管理 | 应用管理:应用列表、应用搜索、应用审核、应用编辑、应用删除,禁用应用,查看应用的接口权限 |
工单管理 | 工单列表:工单列表、工单过滤、工单回复和处理、工单详情查看 |
素材库 | 文件管理:文件列表、文件搜索 |
配置管理 | 配置管理:配置列表、配置编辑、配置删除、配置搜索 |
异步消息队列管理 | 主题订阅管理:发布新消息主题,进行增删改查,以及推送次数统计; |
计划任务 | 计划任务列表:任务列表、开启/关闭任务、删除任务、运行结果查看 |
数据库管理 | 数据库配置:支持MySQL、SQL Server等动态数据库源管理和配置、使用,DI数据库服务使用延时初始化,保证数据库连接性能 、测试数据库连接 |
信息中心 | 文章列表:文章的列表展示,检索,前台访问、编辑和删除等操作; |
统计 | 应用历史统计:统计每个应用每日的汇总数据,支持查看付费接口、试用接口、普通接口、扣费失败接口请求统计 |
权限管理 | 管理后台权限分配:Admin管理后台的权限分配、管理员角色等级、添加/删除新菜单操作、权限分配与取消 |
具体的PRD原型设计,则根据你的平台定位及功能清单展开。
如何使用接口管理平台?
首页模块,从上往下,依次有:顶部网站菜单(含 管理后台,可自行隐藏)、接口搜索、接口分类、Banner轮播图、信息文章发布、三个广告位的运营、优惠套餐推荐、热门接口(分为:免费接口/付费接口/热门接口)。
以下为截图长图(手机版查看时,避免超了流量),
使用1:登录管理后台以及管理后台的首页功能介绍
使用2:核心的使用,包括开发者账号及开发者应用的管理。
概念解释:开发者是使用开放平台的人;而最终调用API接口的对象不是开发者本人,而是开发者开发出来的客户端或应用。故而需要在开发者名下设计他的多个应用,方便进行接口权限的分配和管理。
使用3:【偏技术】API低代码开发、一键发布、自动生成API接口文档;API接口权限分配和管理,以及接口权限的申请。
API接口低代码的开发包括从接口生成、接口在线调试、接口文档的自动生成和API接口的在线调试,一气呵成。
以下是自动生成API在线接口文档的完整截图,非常方便不懂技术开发的人员使用(长图)。
对于生成和开发且发布后的API接口权限,分为两种接口权限管理模式。一种是在管理后台预设好每个开发者角色拥有哪些接口权限,这样一旦新的开发者注册后就可以自动获得对应的接口能力;另一种模式是由注册的新开发者用户主动申请需要哪些接口权限,然后在管理后台再进行人工审核。
除此之外,接口管理平台还应搭载数据库连接的能力,包括常用的数据库:MySQL、PostgreSQL数据库、SQL Server数据库、国产高斯数据库、和Oracle数据库等,以及数据库存储过程的管理能力。
使用4:【偏运营】站点全局配置、后台权限分配、开放平台权限分配、报表统计、订单管理等。
运营分为两条主线,一条主线是常规的站点运营,包括:基本的全局站点配置,包括网站备案号、网站名称和Logo图标、网站统计代码和SEO优化等;和平台菜单权限的分配。另一条线是运营统计报表,包括在用户侧、GMV收入侧和接口实际每天调用消耗侧,这三个最具有代表性维度的统计和分析。
关于作者
黄禅宗 dogstar,果创科技CEO、多家企业CTO、前唯品会高级开发工程师,PhalApi开源框架作者,著有《良质!》等电子书,YesApi果创云创始人、YesDev项目管理创始人,海军退役士兵,毕业于华南师范大学。深耕软件研发,喜欢每天分享技术干货。