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

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

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

相关文章

在java的类中即可以有main方法也可以没有main方法

原理: 在Java中,一个类可以没有main方法。main方法是Java程序的入口点,它是程序执行的起始点。如果一个类没有main方法,那么该类无法直接作为可执行程序运行。 然而,一个Java程序可以包含多个类,其中只需要一个类包含…

【gpt实践】李某的AI课程值199吗

先说个人的答案:不值。但也不是说毫无价值,只是他的价值没那么高。 文末分享该课程,大家有兴趣可以看看,该课程是否有价值。 “清华博士”推出的199元的AI课程销售额竟然突破了5000万。这一数字让人惊叹,也引发了人们…

亚马逊、速卖通卖家如何做好测评让店铺销量稳定增长?

近期有刚入驻跨境电商的新买家咨询珑哥,店铺上的产品有人浏览,就是没有人下单,新店铺很正常因为很多人去购买东西,首先看的是评价,没有评价一般人不敢直接去下单。就像我们去淘宝买东西,都要看下评价&#…

一次性插入10万条数据,该如何操作?

参考:10万条数据批量插入,到底怎么做才快? - 知乎 (zhihu.com) 首先一般有两种方式:1.使用jdbc批处理模式 2.使用insert into values方式 第一种方式:他的优势是jdbc会帮我们进行预编译,然后把预编译结果缓存起来&a…

题解:P9176 [COCI2022-2023#4] Vrsta

什么是线段树&#xff0c;超详细讲解 思路 考虑以每个身高作为下标&#xff0c;维护每个身高的数量&#xff0c;很显然不同的身高最多有 2 1 0 5 2\times 10^5 2105 个&#xff0c;考虑离散化&#xff0c;代码如下&#xff1a; for (int i 1; i < n; i ) {int x a[i]…

测试用例的设计(2)

目录 1.前言 2.正交排列(正交表) 2.1什么是正交表 2.2正交表的例子 2.3正交表的两个重要性质 3.如何构造一个正交表 3.1下载工具 3.1构造前提 4.场景设计法 5.错误猜测法 1.前言 我们在前面的文章里讲了测试用例的几种设计方法,分别是等价类发,把测试例子划分成不同的类…

鸿蒙Harmony应用开发—ArkTS声明式开发(基础手势:Web)上篇

提供具有网页显示能力的Web组件&#xff0c;ohos.web.webview提供web控制能力。 说明&#xff1a; 该组件从API Version 8开始支持。后续版本如有新增内容&#xff0c;则采用上角标单独标记该内容的起始版本。示例效果请以真机运行为准&#xff0c;当前IDE预览器不支持。 需要权…

Java项目:基于springboot实现的OA协同办公系统(源码+数据库+毕业论文)

一、项目简介 本项目是一套基于Springbootvue实现的付费自习室系统 包含&#xff1a;项目源码、数据库脚本等&#xff0c;该项目附带全部源码可作为毕设使用。 项目都经过严格调试&#xff0c;eclipse或者idea 确保可以运行&#xff01; 该系统功能完善、界面美观、操作简单、…

从零开始利用MATLAB进行FPGA设计(一):建立脉冲检测模型的Simulink模型2

目录 1.模块的总体结构 1.1从工作空间导入输入信号 1.2FIR滤波器 2.Subsystem 3.MATLAB Function 文章灵感来源于MATLAB官方免费教程&#xff1a;HDL Coder Self-Guided Tutorial 考虑到MATLAB官网的英文看着慢&#xff0c;再加上视频讲解老印浓浓的咖喱味&#xff0c;我…

【CSP】2021-12-2 序列查询新解 分段处理 用乘法代替加法减少时间复杂度(思想是离散化)

2021-12-2 序列查询新解 分段处理 用乘法代替加法减少时间复杂度&#xff08;思想是离散化&#xff09;2021-12-2 序列查询新解 分段处理 用乘法代替加法减少时间复杂度&#xff08;思想是离散化&#xff09; 2021-12-2 序列查询新解 分段处理 用乘法代替加法减少时间复杂度&am…

python面向对象练习一

假设我们正在开发一个学生管理系统&#xff0c;我们需要创建一个Student类来表示学生对象。 每个学生都有学号、姓名和年龄属性。我们还希望能够打印学生的信息&#xff0c;并在删除学生对象时输出一条提示消息。 要求使用__str__()管理学生信息的打印 要求使用__del__()管理删…

PTA L1-043 阅览室(C++)

天梯图书阅览室请你编写一个简单的图书借阅统计程序。当读者借书时&#xff0c;管理员输入书号并按下S键&#xff0c;程序开始计时&#xff1b;当读者还书时&#xff0c;管理员输入书号并按下E键&#xff0c;程序结束计时。书号为不超过1000的正整数。当管理员将0作为书号输入时…

代码随想录算法训练营第39天—动态规划07 | ● 70. 爬楼梯 (进阶) ● 322. 零钱兑换 ● 279.完全平方数

70. 爬楼梯 &#xff08;进阶&#xff09; https://programmercarl.com/0070.%E7%88%AC%E6%A5%BC%E6%A2%AF%E5%AE%8C%E5%85%A8%E8%83%8C%E5%8C%85%E7%89%88%E6%9C%AC.html 考点 完全背包 我的思路 本题就是用完全背包的思路解决排列问题&#xff0c;一个背包、多个物品&#…

echarts绘制柱状图

<template><div><div>【大区数据信息】</div><div ref"target" class"w-full h-full" ></div></div> </template><script setup> import { ref, onMounted, watch} from "vue"; import *…

RC522刷卡电路设计及程序

一、RC522刷卡电路组成 基于RC522的刷卡电路如上图所示。该电路组成主要分为三部分&#xff1a; Receiving Circuit&#xff1a;接收电路&#xff0c;接收卡发送的数据。 Filtering Impedence-Transtorm circuit:滤波和阻抗变换电路&#xff0c;抑制高次谐波并优化到读卡器天线…

手把手写深度学习(23):视频扩散模型之Video DataLoader

手把手写深度学习(0)&#xff1a;专栏文章导航 前言&#xff1a;训练自己的视频扩散模型的第一步就是准备数据集&#xff0c;而且这个数据集是text-video或者image-video的多模态数据集&#xff0c;这篇博客手把手教读者如何写一个这样扩散模型的的Video DataLoader。 目录 准…

【Vue3】深入理解Vue3路由器的工作原理to的两种写法

&#x1f497;&#x1f497;&#x1f497;欢迎来到我的博客&#xff0c;你将找到有关如何使用技术解决问题的文章&#xff0c;也会找到某个技术的学习路线。无论你是何种职业&#xff0c;我都希望我的博客对你有所帮助。最后不要忘记订阅我的博客以获取最新文章&#xff0c;也欢…

推荐一个非常好用的表格组件 - AG Grid

一、前言 最近在做一个线上订货平台的项目&#xff0c;用户之前都是使用传统的Excel表格完成工作数据的提交和汇总&#xff0c;工作效率非常低。 希望我们能将历年的各项数据导入系统&#xff0c;之后可以参照历年数据格式&#xff0c;能直接在系统上创建新的工作&#xff0c…

Realsense 相机SDK学习(一)——librealsense使用方法及bug解决(不使用Ros)

一.介绍 realsense相机是一个intel开发出来的一款深度相机&#xff0c;我之前使用他来跑过slam&#xff0c;也配置过他的驱动&#xff0c;在此附上realsense的相机驱动安装方法&#xff1a;Ubuntu20.04安装Intelrealsense相机驱动&#xff08;涉及Linux内核降级&#xff09; …

c# 的ref 和out

在C#中&#xff0c;ref和out是用于方法参数的关键字&#xff0c;它们都允许在方法调用中对参数进行修改。 ref关键字用于传递参数的引用。当使用ref关键字声明一个参数时&#xff0c;实际上是在告诉编译器此参数在调用方法之前必须被赋值。ref参数传递的是参数的引用地址&…