【国产】API接口管理平台的产品设计与搭建讲解

news2024/7/6 18:03:05

【国产接口管理平台】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接口计费

接口流量套餐:支持试套餐和付费套餐,接口流量套餐列表、添加套餐、修改套餐、删除套餐,支持组合套餐
订单管理:订单列表、修改订单、套餐调整
套餐管理:套餐列表、套餐发放、调整套餐、删除套餐
支付配置:支付宝配置、PayPal配置、现金支付配置

开发者余额充值

充值审核:后台进行开发者余额审核;
余额查看:查看开发者钱包余额,以及充值申请;
扣费明细:提供接口调用账单查询和Excel导出;
接口单价:设定单个接口的单价,精确到小数点后6位;

API接口管理

低代码接口开发:自动生成API接口源代码,接口管理、在线开发、发布、自动生成,支持网关接口、数据库接口、普通接口生成模式、支持GET/POST方法设置,生成数据API接口时可以选择数据库和数据库表,同时支持 简易代码模式和完整代码模式
接口导入:支持swagger批量导入API接口,支持多个接口的勾选、覆盖导入和快速发布 

接口权限

接口权限分配:接口权限分配,自动检测API接口资产,支持快速按配置的开发者角色进行接口权限分配,列表查看
权限预览:查看、预览和搜索指定应用的接口权限
接口权限规则设置:支持接口权限的规则配置、添加、列表查看、搜索和删除、撤销等接口,权限规则支持按开发者角色、开发者账号、开发者应用共三个维度
接口服务操作列表:支持手动添加接口服务

接口测试

接口测试:自动化接口测试,接口测试、全局access_token配置、搜索用例、添加新用例、运行用例、编辑查看用例、测试报告
添加新用例:添加接口新的测试用例,支持接口参数配置,接口结果验证规则配置,待测试接口选择等
全局access_token配置:添加、删除和更新接口测试token

接口监控

实时接口流量统计:接口流量统计拆线叠加图,支持日期范围搜索,支持查看付费接口、试用接口、普通接口、扣费失败接口请求统计
每日接口统计:每日接口统计,支持日期范围、开发者账号、AppKey、API接口的搜索 

接口监控:可以查看API接口的响应时间和分析、监控
接口访问日志:接口流量请求访问日志,支持接口或app_key搜索,付费接口类型的查询,接口参数查看

账号管理

账号列表:账号搜索、账号列表、账号修改、账号删除
添加账号:添加新账号
模拟登录、用户轨迹

应用管理

应用管理:应用列表、应用搜索、应用审核、应用编辑、应用删除,禁用应用,查看应用的接口权限
创建新应用:创新新应用,支持绑定到开发者账号
编辑应用:更换app_secret密钥、限制应用每日接口请求次数(不限制或指定次数上限)、设定接口请求的客户端IP白名单、应用有效日期

工单管理

工单列表:工单列表、工单过滤、工单回复和处理、工单详情查看
工单处理:回复处理工单

素材库

文件管理:文件列表、文件搜索
上传文件:上传新的图片或其他文件

配置管理

配置管理:配置列表、配置编辑、配置删除、配置搜索
添加配置:添加新配置

异步消息队列管理

主题订阅管理:发布新消息主题,进行增删改查,以及推送次数统计;
开发者应用订阅管理:对开发者申请的应用订阅进行审核,可通过或拒绝,以及查看订阅列表;
推送记录:支持平台推送记录的查看、搜索、重发;
服务端脚本:提供消费者运行脚本、守护进程;

计划任务

计划任务列表:任务列表、开启/关闭任务、删除任务、运行结果查看
添加计划任务:新加新的任务

数据库管理

数据库配置:支持MySQL、SQL Server等动态数据库源管理和配置、使用,DI数据库服务使用延时初始化,保证数据库连接性能 、测试数据库连接
存储过程管理:支持存储过程的创建、管理和在线测试,以及结合接口进行低代码开发;
数据库统计:数据库总大小、数据大小、索引大小、丙图、数据库表统计
数据库实时进程:实时进程列表

信息中心

文章列表:文章的列表展示,检索,前台访问、编辑和删除等操作;
发布新文章:支持管理后台可视化编辑发布文章,设置文章标题、文章摘要、文章关键词、封面、内容、查看权限(游客/会员/隐藏/下架)、排序、发布时间等信息。

统计

应用历史统计:统计每个应用每日的汇总数据,支持查看付费接口、试用接口、普通接口、扣费失败接口请求统计
每日注册统计:每日账号注册人数统计及同比上个月,拆线图,支持日期范围搜索,统计表格
每日登录统计:每日账号登录成功与失败的统计及同比上个月,拆线图,支持日期范围搜索,统计表格

权限管理

管理后台权限分配:Admin管理后台的权限分配、管理员角色等级、添加/删除新菜单操作、权限分配与取消
开放平台权限分配:Platform开放平台的权限分配、管理员角色等级、添加/删除新菜单操作、权限分配与取消

具体的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项目管理创始人,海军退役士兵,毕业于华南师范大学。深耕软件研发,喜欢每天分享技术干货。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1510097.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

MySQL安装使用(mac、windows)

目录 macOS环境 一、下载MySQL 二、环境变量 三、启动 MySql 四、初始化密码设置 windows环境 一、下载 二、 环境配置 三、安装mysql 1.初始化mysql 2.安装Mysql服务 3.更改密码 四、检验 1.查看默认安装的数据库 2.其他操作 macOS环境 一、下载MySQL 打开 MyS…

C++的学习

代码练习 输入一个字符串&#xff0c;统计其中大写字母、小写字母、数字、空格以及其他字符的个数 #include <iostream>using namespace std;int main() {cout << "请输入一个字符串" << endl;string str;getline(cin,str);int capital 0;int l…

C语言游戏实战(11):贪吃蛇大作战(多人对战)

成果展示&#xff1a; 贪吃蛇&#xff08;多人对战&#xff09; 前言&#xff1a; 这款贪吃蛇大作战是一款多人游戏&#xff0c;玩家需要控制一条蛇在地图上移动&#xff0c;吞噬其他蛇或者食物来增大自己的蛇身长度和宽度。本游戏使用C语言和easyx图形库编写&#xff0c;旨在…

功能测试转自动化测试好不好转型?

手工测试做了好多年&#xff0c;点点点成了每天必须做的事情。但是随着自动化测试趋势的日渐明显&#xff0c;以及受到薪资、技能的双重考验&#xff0c;掌握自动化测试成为了必备技能。 手工转自动化测试&#xff0c;不是一蹴而就的。“预先善其事&#xff0c;必先利其器”&a…

C++中的RAII原则和资源管理如何提高程序效率和安全性?

文章目录 C中的RAII&#xff08;Resource Acquisition Is Initialization&#xff09;原则是一种编程范式&#xff0c;它确保资源在其生命周期内的有效管理。RAII的核心思想是在对象创建时&#xff08;初始化阶段&#xff09;获取资源&#xff0c;并在对象销毁时&#xff08;析…

C# 8.0+版本项目 string不可为空

1.在某一次新建项目的时候发现&#xff0c;新建的项目&#xff0c;写的测试接口&#xff0c;接口的入参有string的参数&#xff0c; 但是调用接口的时候string的参数没有传报了400&#xff0c;很奇怪&#xff0c;也没有语法错误之类的。 2.解决办法 在项目上右键->属性->…

HTML静态网页成品作业(HTML+CSS)——家乡漳州介绍设计制作(1个页面)

&#x1f389;不定期分享源码&#xff0c;关注不丢失哦 文章目录 一、作品介绍二、作品演示三、代码目录四、网站代码HTML部分代码 五、源码获取 一、作品介绍 &#x1f3f7;️本套采用HTMLCSS&#xff0c;未使用Javacsript代码&#xff0c;共有1个页面。 二、作品演示 三、代…

Flink技术简介与入门实践

架构简介 Flink 是一个分布式流处理和批处理计算框架&#xff0c;具有高性能、容错性和灵活性。下面是 Flink 的架构概述&#xff1a; JobManager&#xff1a;JobManager 是 Flink 集群的主节点&#xff0c;负责接收和处理用户提交的作业。JobManager 的主要职责包括&#xff1…

NASA数据集——亚马逊盆地与其大气边界层之间各种气溶胶和气体交换率的估计值数据

简介 Pre-LBA ABLE-2A and ABLE-2B Expedition Data ABLE 2A 和 2B&#xff08;大气边界层实验&#xff09;数据包括亚马逊盆地与其大气边界层之间各种气溶胶和气体交换率的估计值&#xff0c;以及这些气溶胶和气体在边界层和自由对流层之间的移动过程。前言 – 人工智能教程…

HTML静态网页成品作业(HTML+CSS)——非遗昆曲介绍设计制作(1个页面)

&#x1f389;不定期分享源码&#xff0c;关注不丢失哦 文章目录 一、作品介绍二、作品演示三、代码目录四、网站代码HTML部分代码 五、源码获取 一、作品介绍 &#x1f3f7;️本套采用HTMLCSS&#xff0c;未使用Javacsript代码&#xff0c;共有1个页面。 二、作品演示 三、代…

如何查找、恢复误清空的 Android 回收站?

“我的回收站里有一些照片。当我点击“恢复”时&#xff0c;没有任何反应。我可以将我的 Android 手机插入我的电脑。这样我就可以手动恢复它们。但我在 Android 上找不到 bin 文件夹。我还可以做些什么&#xff1f;” 随着 Android 手机上的文件数量不断增加&#xff0c;了解…

SimplifyRODataLoads - 优化阅读笔记

// 只支持 X86 static cl::opt<bool> SimplifyRODataLoads("simplify-rodata-loads",cl::desc("通过用相应节中找到的常数替换内存操作数&#xff0c;简化来自只读节的加载"),cl::cat(BoltOptCategory));测试用例&#xff1a; ./build4/bin/llvm-li…

【汇编】#3 8086与数据有关的寻址方式

文章目录 操作码与操作数1. 8086处理器的与数据有关的寻址方式1.1 立即数寻址方式1.2 寄存器寻址方式 2. 有效&#xff08;偏移&#xff09;地址&#xff08;effective address&#xff0c;EA&#xff09;与缺省段寄存器选择tips:段跨越前缀2.1 直接寻址tips:直接寻址与立即寻址…

什么是农业气象站?——气象科普

农业气象站&#xff0c;也被称为田间气象站或农业小气候仪&#xff0c;是一款综合的物联网农业气象参数观测系统。它能够实时、准确、有针对性地监测农田区域内的多种气象参数&#xff0c;包括温湿度、光照、二氧化碳浓度、大气压、雨量、土壤温湿度、风速风向等。 农业气象站…

【MATLAB 】 EMD信号分解+FFT傅里叶频谱变换组合算法

有意向获取代码&#xff0c;请转文末观看代码获取方式~ 展示出图效果 1 EMD信号分解算法 EMD 分解又叫经验模态分解&#xff0c;英文全称为 Empirical Mode Decomposition。 EMD 是一种信号分解方法&#xff0c;它将一个信号分解成有限个本质模态函数 (EMD) 的和&#xff0c…

【Linux】文件缓冲区|理解文件系统

目录 预备知识 观察现象 第一&#xff1a;携带\n&#xff0c;不使用fork()&#xff0c;打印到显示器 第二&#xff1a;携带\n&#xff0c;使用fork()&#xff0c;打印到显示器 第三&#xff1a;携带\n&#xff0c;使用fork()&#xff0c;打印到文件里 第四&#xff1a;不携…

【R语言实战】——金融时序分布拟合

&#x1f349;CSDN小墨&晓末:https://blog.csdn.net/jd1813346972 个人介绍: 研一&#xff5c;统计学&#xff5c;干货分享          擅长Python、Matlab、R等主流编程软件          累计十余项国家级比赛奖项&#xff0c;参与研究经费10w、40w级横向 文…

常见的限流算法- python版本

shigen坚持更新文章的博客写手&#xff0c;擅长Java、python、vue、shell等编程语言和各种应用程序、脚本的开发。记录成长&#xff0c;分享认知&#xff0c;留住感动。 个人IP&#xff1a;shigen 在系统的稳定性设计中&#xff0c;需要考虑到的就是限流&#xff0c;避免高并发…

DC/DC高压模块直流升压可调稳压输出升压变换器5V12V24V48V转50V110V150V130V200V250V300V450V500V600V800V

特点 效率高达 80%以上1*2英寸标准封装单电压输出价格低稳压输出工作温度: -40℃~85℃阻燃封装&#xff0c;满足UL94-V0 要求温度特性好可直接焊在PCB 上 应用 HRB W2~40W 系列模块电源是一种DC-DC升压变换器。该模块电源的输入电压分为&#xff1a;4.5~9V、9~18V、及18~36V、…

容量治理三板斧:扩容、限流与降级

前言 随着现代软件系统日益复杂和用户规模的不断增长&#xff0c;分布式架构成为了保持系统高可用性与高性能的标准解决方案。然而&#xff0c;随之而来的是对系统容量治理的新挑战。在这样的背景下&#xff0c;容量治理成为了分布式系统设计和运维中不可或缺的一环。要确保系…