【国产】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,一经查实,立即删除!

相关文章

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

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

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

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

测试用例的设计(2)

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

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

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

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

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

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

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

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

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

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;也欢…

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

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

【四】【算法分析与设计】贪心算法的初见

455. 分发饼干 假设你是一位很棒的家长&#xff0c;想要给你的孩子们一些小饼干。但是&#xff0c;每个孩子最多只能给一块饼干。 对每个孩子 i&#xff0c;都有一个胃口值 g[i]&#xff0c;这是能让孩子们满足胃口的饼干的最小尺寸&#xff1b;并且每块饼干 j&#xff0c;都有…

AI时代Python金融大数据分析实战:ChatGPT让金融大数据分析插上翅膀【文末送书-38】

文章目录 Python驱动的金融智能&#xff1a;数据分析、交易策略与风险管理Python在金融数据分析中的应用 实战案例&#xff1a;基于ChatGPT的金融事件预测AI时代Python金融大数据分析实战&#xff1a;ChatGPT让金融大数据分析插上翅膀【文末送书-38】 Python驱动的金融智能&…

eVTOL适航领先新构型,沃飞长空布局空中交通新局面

汽车、火车、飞机……人类对于出行方式的探索从未停止。随着沃飞长空旗下首款自研eVTOL(飞行汽车)AE200适航技术验证机一阶段顺利试飞,eVTOL(飞行汽车)这种面向空中交通的新型交通工具进入了我们的视野,那么eVTOL(飞行汽车)是什么?eVTOL(飞行汽车)前景怎么样? eVTOL(飞行汽车…

Power Apps 学习笔记 -- Action

文章目录 1. Action 简介2. Action 配置3. 待补充 1. Action 简介 Action基础教程 : Action概述 操作Action: 1. 操作Action类似于工作流Workflow&#xff0c;提供一些重用性的操作&#xff0c;允许工作流或其他Web服务端点调用(例如javascript). 2. Action 类似于c#当中的一个…

专题二 -滑动窗口 - leetcode 209. 长度最小的子数组 | 中等难度

leetcode 209. 长度最小的子数组 leetcode 209. 长度最小的子数组 | 中等难度1. 题目详情1. 原题链接2. 基础框架 2. 解题思路1. 题目分析2. 算法原理3. 时间复杂度 3. 代码实现4. 知识与收获 leetcode 209. 长度最小的子数组 | 中等难度 1. 题目详情 给定一个含有 n 个正整数…

Android14音频进阶:AudioTrack如何巧妙衔接AudioFlinger(五十七)

简介: CSDN博客专家,专注Android/Linux系统,分享多mic语音方案、音视频、编解码等技术,与大家一起成长! 优质专栏:Audio工程师进阶系列【原创干货持续更新中……】🚀 优质专栏:多媒体系统工程师系列【原创干货持续更新中……】🚀 人生格言: 人生从来没有捷径,只…

人工智能迷惑行为大赏!

目录 人工智能迷惑行为大赏 一&#xff1a;人工智能的“幽默”瞬间 1. 图像识别出现AI的极限 2. 小批量梯度下降优化器 3. 智能聊天机器人的冰雹问题 4. 大语言模型-3经典语录 二&#xff1a;技术原理探究 1. 深度学习 2. 机器学习 3. 自然语言处理 4. 计算机视觉 三…

博士推荐 | 拥有10多年纺织工程经验,纤维与聚合物科学博士

编辑 / 木子 审核 / 朝阳 伟骅英才 伟骅英才致力于以大数据、区块链、AI人工智能等前沿技术打造开放的人力资本生态&#xff0c;用科技解决职业领域问题&#xff0c;提升行业数字化服务水平&#xff0c;提供创新型的产业与人才一体化服务的人力资源解决方案和示范平台&#x…