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

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

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

可视化表单流程编辑器为啥好用?

想要提升办公率、提高数据资源的利用率,可以采用可视化表单流程编辑器的优势特点,实现心中愿望。伴随着社会的进步和发展,提质增效的办公效果一直都是很多职场办公团队的发展需求,作为低代码技术平台服务商,流辰信息团…

MySQL8.0安装教程+使用Navicat远程连接

MySQL8.0安装教程使用Navicat远程连接 版本:MySQL8.0.28 环境:Windows11 1.MySQL下载 进入官网https://www.mysql.com/进行下载: 2.安装MySQL 下载好后,点击运行程序开始安装,安装步骤如下: 以下步骤验…

MSigDB数据库 | 富集分析需要的基因集该去哪里找?如何选择适合自己数据的基因集?

富集分析可以说是我们的老帮手了!进行富集分析,就不能不提基因集,那基因集我们该去哪里找呢?我们又该如何选择适合自己数据的基因集呢?咱们今天就来浅浅唠一唠! 最常见的操作就是去MSigDB数据库找现成的基因…

2024-3-11-C++作业

1>试编程 要求&#xff1a; 提示并输入一个字符串&#xff0c;统计该字符中大写、小写字母个数、数字个数、空格个数以及其他字符个数 源代码: #include <iostream>using namespace std;int main() {string s;cout << "请输入字符串&#xff1a;"…

RESTful接口规范参考

介绍 REST&#xff08;Representational State Transfe&#xff09;&#xff0c;一种架构设计风格&#xff0c;而不是强制标准&#xff0c;主要用于客户端与服务端接口规范&#xff1b;在现代的软件开发中&#xff0c;RESTful API已经成为应用程序之间通信的重要桥梁&#xff…

淘宝扭蛋机小程序开发:惊喜与趣味,尽在一扭之间

随着移动互联网的快速发展&#xff0c;小程序作为一种轻量级、便捷的应用形式&#xff0c;受到了广大用户的青睐。为了满足淘宝用户对新鲜、有趣购物体验的需求&#xff0c;我们倾力打造了淘宝扭蛋机小程序&#xff0c;为用户带来全新的购物乐趣和惊喜体验。 淘宝扭蛋机小程序…

【JavaScript标准内置对象】Math的介绍。

简言 js与其他高级语言一样&#xff0c;也可以进行数学运算。 Math 是一个内置对象&#xff0c;它拥有一些数学常数属性和数学函数方法。Math 不是一个函数对象。 Math 用于 Number 类型。它不支持 BigInt。 Math 与其他全局对象不同的是&#xff0c;Math 不是一个构造器。Ma…

CANalyzer使用_02 测试环境搭建

本文主要介绍CANalyzer测试环境的搭建。主要是硬件方面&#xff0c;软件方面要跟着进行配合。根据ISO 11898标准&#xff0c;如果是高速&#xff0c;记得要加120Ω的终端电阻。 1 两个CAN短接 如下图所示&#xff0c;用两端都是DB9的线将VN1630A的CH1和CH2的端口短接。VN1630…

SpringSecurity 快速入门

文章目录 1. 认证授权概述1.1 认证授权概念1.1.1 认证1.1.2 授权 1.2 权限数据模型1.3 RBAC权限模型1.3.1 介绍1.3.2 基于角色访问控制1.3.3 基于资源访问控制 1.4 常见认证方式1.4.1 Cookie-Session1.4.2 jwt令牌无状态认证 1.5 技术实现 2. SpringSecurity入门2.1 介绍2.2 入…

人数统计显示屏对粉尘车间人员进出管理

2022年1月20日&#xff0c;江苏省常州市某公司的粉尘车间发生了一起严重的粉尘爆炸事故&#xff0c;这一悲剧造成了8人死亡和8人受伤。这起事故引起了社会各界的广泛关注&#xff0c;也再次凸显了工业安全管理的重要性。 据报道&#xff0c;这起粉尘爆炸事故发生在公司的粉尘车…

ModuleNotFoundError: No module named ‘serial.tools‘

解决以上报错的方法&#xff1a; 1、大家在使用以下代码时&#xff1a; port_list list(serial.tools.list_ports.comports()) 会出现报错&#xff1a; ModuleNotFoundError: No module named serial.tools; serial is not a package 这个时候我们应该先安装serial 然…

Spring Boot整合zxing实现二维码登录

zxing是google的一个二维码生成库&#xff0c;使用时需配置依赖&#xff1a; implementation("com.google.zxing:core:3.4.1") implementation("com.google.zxing:javase:3.4.1") zxing的基本使用 我们可以通过MultiFormatWriter().encode()方法获取一个…

PMP考试:如何高效学习PMBOK?

PMBOK&#xff08;项目管理知识体系指南&#xff09;是PMP考试的核心教材&#xff0c;学习PMBOK对于备考PMP考试至关重要。那么我将分享一些高效学习PMBOK的方法和技巧&#xff0c;帮助同学们更好地掌握项目管理知识。 一、制定学习计划 在学习PMBOK之前&#xff0c;制定一个详…

嵌入式系统中端口号的理解与分析

每当看到有人的简历上写着熟悉 tcp/ip, http 等协议时, 我就忍不住问问他们: 你给我说说, 端口是啥吧! 可惜, 很少有人能说得让人满意... 所以这次就来谈谈端口(port), 这个熟悉的陌生人. 在此过程中, 还会谈谈间接层, naming service 等概念, IoC, 依赖倒置等原则以及 TCP 协议…

【linux】02 :Linux基础命令

1.掌握linux系统的目录结构 linux只有一个顶级目录&#xff0c;称之为&#xff1a;根目录。 windows系统有多个顶级目录&#xff0c;即各个盘符。 2.linux路径的描述方式 /在Linux中的表示&#xff1a;出现在开头表示根目录&#xff0c;出现在后面表示层级关系。 3.什么是命…

项目管理工具及模板(甘特图、OKR周报、任务管理、头脑风暴等)

项目管理常用模板大全&#xff1a; 1. 项目组OKR周报 2. 项目组传统周报工作法 3. 项目甘特图 4. 团队名单 5. 招聘跟进表 6. 出勤统计 7. 年度工作日历 8. 项目工作年计划 9. 版本排期 10. 项目组任务管理 11. 项目规划模板 12. 产品分析报告 13. 头脑风暴 信息化项目建设全套…

vuetify3+vite,打包后mdi图标无法正常显示,及打包后首页白屏

1、图标无法正常显示 【因为我的vite.config.ts配置中使用了vite-plugin-css-injected-by-js这个插件】 为了优化我的项目&#xff0c;我使用了很多插件&#xff0c;vite-plugin-css-injected-by-js就是其中一个&#xff0c;项目本地运行是正常的&#xff0c;但是当我使用unia…

【梳理】k8s使用Operator搭建Flink集群(高可用可选)

文章目录 1. 架构图2. helm 安装operator3. 集群知识k8s上的两种模式&#xff1a;Native和Standalone两种CR 4. 运行集群实例Demo1&#xff1a;Application 集群Demo2&#xff1a;Session集群优劣 5. 高可用部署问题1&#xff1a;High availability should be enabled when sta…

【LeetCode】升级打怪之路 Day 18:二叉树题型 —— 树的深度、高度、路经

今日题目&#xff1a; 104. 二叉树的最大深度111. 二叉树的最小深度110. 平衡二叉树257. 二叉树的所有路径112. 路径总和 目录 Problem 1&#xff1a;树的深度LC 104. 二叉树的最大深度 【easy】LC 111. 二叉树的最小深度 【易错】 Problem 2&#xff1a;树的高度LC 110. 平衡二…

【阿里云系列】-如何实现两个VPC网络资源互通

背景 由于实际项目预算有限&#xff0c;两套环境虽然分别属于不同的专有网络即不同的VPC&#xff0c;但是希望借助一台运维机器实现对两个环境的监控和日常的运维操作 网络架构 如下是需要实现的外网架构图&#xff0c;其中希望实现UAT环境的一台windows的堡垒机可以访问生产…