专业的编程技术博客社区

网站首页 > 博客文章 正文

推荐好用的YApi接口管理平台,厌倦了Swagger就用他了

baijin 2024-08-18 13:22:22 博客文章 4 ℃ 0 评论

1、YApi 可视化接口管理平台

YApi 是高效易用功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

特性

  • 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
  • 扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
  • 类似 postman 的接口调试
  • 自动化测试, 支持对 Response 断言
  • MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
  • 支持 postman, har, swagger 数据导入
  • 免费开源,内网部署,信息再也不怕泄露了

2、YApi 本地安装部署

环境要求

  • Nodejs
    • 安装nodejs

下载地址:http://nodejs.cn/download/

下载nodejs历史版本地址:https://nodejs.org/zh-cn/download/releases/

安装版本12.0的否则有会些bug, 默认下一步安装即可

  • mongodb
    • 安装mongodb并启动mongodb

下载地址:

1、https://www.mongodb.com/try/download 用这个下载路径

2、http://www.mongodb.org/dl/win32/x86_64 备用下载路径

完全安装,并将可视化工具也进行安装。

  • 将mongod以windows服务运行

安装完mongodb后需要将mongo转换成windows服务运行命令行如下:

创建mongodb配置文件,文件名称为:mongodb.cfg

文件内容为:

systemLog:

destination: file

path: G:\我的笔记\db\yapimongodb\logs\mongodb.log

storage:

dbPath: G:\我的笔记\db\yapimongodb

运行CMD 跳转到mongodb安装bin下

cmd用管理员权限访问

运行如下命令

mongod.exe --config "C:\Program Files\MongoDB\Server\3.6\bin\mongodb.cfg" --install

  • YApi
    • 下载解压YApi

下载地址:

1、https://gitee.com/mirrors/YApi

2、https://github.com/YMFE/yapi

  • 解压安装

下载后将压缩包解压到指定的文件夹下,

通过管理员权限运行CMD.

CMD跳转到YApi解压目录下,输入如下命令:

npm install -g yapi-cli --registry https://registry.npm.taobao.org

安装完成之后查看安装目录为D:\Program Files\nodejs\node_cache\yapi-cli

那么我们需要将其跳转到安装目录下在执行yapi server

如下图:

这样Yapi就安装部署好了。访问地址为:

http://127.0.0.1:9090/

http://localhost:9090/

  • 运行YApi服务 此处可以不用安装。

服务管理

利用pm2方便服务管理维护。

npm install pm2 -g //安装pm2
cd {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

缺少安装包需要手动安装组件

3、Yapi 部署

Yapi 平台部署

http://127.0.0.1:9090

输入公司信息以及平台信息开始部署,等待部署完成。

完成后访问:http://127.0.0.1:3000


Tags:

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表