前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >一键迁移接口,即刻搭建企业接口开放平台 - YesApi接口大师v3.15

一键迁移接口,即刻搭建企业接口开放平台 - YesApi接口大师v3.15

原创
作者头像
dogstar
发布2022-08-26 15:48:12
9970
发布2022-08-26 15:48:12
举报
文章被收录于专栏:YesDev研发协同工具

企业自建API接口开放平台的解决方案

根据百度百科的定义,

开放平台(Open Platform) 在软件行业和网络中,开放平台是指软件系统通过公开其应用程序编程接口(API)或函数(function)来使外部的程序可以增加该软件系统的功能或使用该软件系统的资源,而不需要更改该软件系统的源代码。 -- 百度百科

不管是互联网平台,还是传统的企业,都可以从构建企业接口开放平台中获取到价值和作用。一方面,可以满足当前下游客户、合作伙伴对于API接口、数据共享、系统对接的开发需求;另一方面,可以培育和搭建基于自己产品和业务的接口开放平台,积累开发者经验和筑建开发者生态。

YesApi接口大师(5合1)

YesApi 接口大师(原名:PhalApi Pro 专业版),是一款企业级API接口管理平台。它通过低代码、可视化配置方式,帮助企业快速搭建API接口开放平台,让企业可以即刻管理API接口资产、对外开放API接口、以及支持API低代码开发。

简而言之,接口大师是一套快速研发、管理和开放API接口的软件产品、源代码和解决方案。除了有源代码,还有开发文档,以及完善的产品软件系统。

接口大师5合1的产品能力,主要包括有:

1、OpenAPI开放接口:提供给客户端、第三方和内部系统调用的API接口。

2、Docs在线接口文档:自动生成的接口文档,支持在线测试、

3、Platform开放平台:提供给内部或外部开发者使用的平台。

4、Admin管理后台:提供给内部管理员使用的总后台。

5、Wiki技术文档:整的二次技术开发手册、使用手册。

一键迁移Eolink/Swagger内部接口

Swagger接口导入

如果原来是使用Swagger维护接口文档的,如果需要变成开放接口,可以进入Admin管理后台,进行在线导入。

Eolink接口导入

如果原来是使用Eolink维护内部接口文档的,可以使用脚本命令方式进行批量导入、和增量迁移。可以批量迁移几百个甚至上千个API接口。迁移方案是:

  • 提供脚本命令,支持一键导入,可重复操作
  • 通过网关方式,连接原来智慧API
  • 为简化开放接口使用,推荐查询类用GET,操作类用POST,不建议使用 PUT/DELETE
  • 自动生成的API代码不建议修改,预留人工二次开发的接口

管理API接口资产

API接口导入后,即可在Admin管理后台进行API接口资产的管理,包括但不限于:接口权限分配、接口请求日记、接口监控、接口流量统计、接口套餐配置、接口测试。

低代码API开发

使用接口大师,除了可以批量一键迁移API接口,还可以快速生成数据库的API接口(能写SQL语句就能低代码开放API接口)。

首先,你可以在管理后台配置多个数据库。

随后,你可以在线生成数据库API接口,选择数据库、选择数据库表,并进行SQL语句编写和调整、接口测试。

最后,发布你的数据API接口。

对外开放API接口

概括来讲,接口大师,一方面可以帮助你快速低代码开发API接口,也能帮你快速一键迁移AIP接口,同时还能通过可视化和配置化的方式轻松管理你的API接口资产和接口文档。

更重要,也是最重要的是,接口大师能够帮助企业快速、轻松对外开放API接口。

这时,我们需要给外部的开发者提供三个核心价值的产品:OpenAPI、在线接口文档以及一个开放平台。

OpenAPI在线接口文档,是开发者查看和使用API接口必备的资料。在接口大师,接口文档是实时根据源代码自动生成的,不需要人工额外维护,既减少了维护成本,又能实时100%保证接口文档的同步和一致性。

开发者可以在开放平台,进行自主注册和登录,以及查看自己的API接口。

最后,开发者要开通账号后,就可以调用和使用OpenAPI开放接口。

技术开发文档

Wiki技术开发文档,是为了方便企业能够二次开发而提供的重要资料。包括了安装、产品使用、开发文档教程和重要配置说明等。

接口大师 v3.15 版本发布与更新的内容

PhalApi专业版 3.15.0 (2022-08)

  • 1、增加接口监控,可以追加查看API接口的响应时间和分析、监控
  • 2、首页UI微调整,更加简洁、美观、大气
  • 3、创建接口时,支持快速创建表
  • 4、Admin管理后台菜单结构调整,更加清晰明了
  • 5、新建接口时,也支持【保存并发布】
  • 6、修复 接口大师v3.13无法可视化安装,提示数据库错误
  • 7、在接口请求日记追加接口参数的记录,可选,默认开启
  • 8、接口计划任务更新:1)定时修复运行异常的任务;2)执行中的任务时间最大调整成10分钟;3)修复开启调试模式下接口结果写入过长问题;4)调整更新使用说明;5)去掉不必要的MQ分表;6)result字段改成text类型;
  • 9、提供手动执行接口的命令方式,提供另一种直接、准确执行接口计划任务的原始方式,并更新技术文档 3.6 接口计划任务。
  • 10、开发者用户新建工单后,支持通知推送(企业微信+钉钉)

如何升级到接口大师v3.15 新版本?

在获取到最新版v3.15.0源代码,源代码后,本次版本更新的主要内容有:

注意!升级前,请注意原有的代码备份!!

1、替换./public/platform目录,更新Platform开放平台的编译包代码(如果原来已经改动Platform源代码,需要合并源码后再编译打包更新,可以使用git的分支合并进行新版本的对比和升级)

2、替换./public/admin目录,更新Admin管理后台的编译包代码(如果原来已经改动Admin源代码,需要合并源码后再编译打包更新,可以使用git的分支合并进行新版本的对比和升级)

3、PHP源代码更新

对比并替换./src/base目录,对比并替换./src/admin目录,对比并替换./src/platform目录,对比并替换./public/api目录。可以使用git的分支合并进行新版本的对比和升级。

4、数据库更新

请见 ./data/phalapi_pro_v3.15.0.sql 数据库文件变更,并执行。

5、config文件目录更新

6、bin命令脚本目录更新

7、composer包更新

执行composer包更新命令:composer udpate。

8、完成升级

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 企业自建API接口开放平台的解决方案
  • YesApi接口大师(5合1)
  • 一键迁移Eolink/Swagger内部接口
  • 管理API接口资产
  • 低代码API开发
  • 对外开放API接口
  • 技术开发文档
  • 接口大师 v3.15 版本发布与更新的内容
  • 如何升级到接口大师v3.15 新版本?
相关产品与服务
腾讯云微搭低代码
微搭低代码是一个高性能的低代码开发平台,用户可通过拖拽式开发,可视化配置构建 PC Web、H5 和小程序应用。 支持打通企业内部数据,轻松实现企业微信管理、工作流、消息推送、用户权限等能力,实现企业内部系统管理。 连接微信生态,和微信支付、腾讯会议,腾讯文档等腾讯 SaaS 产品深度打通,支持原生小程序,助力企业内外部运营协同和营销管理。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档