Yapi的安装与使用

2023-11-08

前言

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

简单来说,就是提供写接口文档的地方,后端人员写接口文档,前端人员直接在上面进行接口查看与开发。
官网链接

安装环境

linux下安装Yapi需要先安装它的依赖环境

安装nodejs(7.6+)

下载nodejs安装包
https://nodejs.org/en/download/

然后通过ftp上传到linux上。

或者直接在linux下载

#  wget https://nodejs.org/dist/v12.16.3/node-v12.16.3-linux-x64.tar.xz

解压

# tar xf node-v12.16.3-linux-x64.tar.xz

解压文件的 bin 目录底下包含了 node、npm 等命令,我们可以使用 ln 命令来设置软连接:

# ln -s /usr/local/node-v12.16.3-linux-x64/bin/npm /usr/local/bin
# ln -s /usr/local/node-v12.16.3-linux-x64/bin/node /usr/local/bin

检查

检查是否安装正确

# node -v
# npm -v

安装mongodb(2.6+)

下载mongodb安装包
https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.18.tgz

也可以去官网下载其他版本
https://www.mongodb.com/download-center/community
然后通过ftp上传到linux上。
解压

# tar -zxvf mongodb-linux-x86_64-4.0.18.tgz 

拷贝到指定目录

# mv mongodb-linux-x86_64-4.0.18 /usr/local/mongodb

配置环境变量

# vi /etc/profile

在最下面添加

export PATH=$PATH:/usr/local/mongodb/bin

创建文件夹
一个存放数据,一个存放日志

# mkdir -p /data/db
# mkdir -p /logs

创建mongodb配置文件
进入bin目录

# cd /usr/local/mongodb/bin

创建mongodb.conf配置文件

# vi mongodb.conf

直接拷贝写进去

dbpath = /data/db # 数据文件存放目录
logpath = /logs/mongodb.log # 日志文件存放目录
port = 27017 # 端口
fork = true # 以守护程序的方式启用,即在后台运行
noauth = true # 不进行安全验证
# auth=true # 需要认证。如果放开注释,就必须创建MongoDB的账号,使用账号与密码才可远程
访问,第一次安装建议注释
bind_ip=0.0.0.0 # 允许远程访问,或者直接注释,127.0.0.1是只允许本地访问

启动mongodb

# ./mongod -f mongodb.conf

检查是否启动成功

# netstat -nltp|grep mongod

或者

# ps -ef | grep mongod

安装yapi-cli

直接在线安装

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

配置yapi

# ln -s /usr/local/node-v12.16.3-linux-x64/bin/yapi /usr/bin/yapi

启动

yapi server

如果访问没效果,请打开9090端口,重启防火墙
永久打开端口

# firewall-cmd --zone=public --add-port=9090/tcp --permanent

重启防火墙

# firewall-cmd --reload

然后再次启动yapi server


写上公司名称,其余一般默认,直接部署即可。

部署成功,请切换到部署目录,输入: “node vendors/server/app.js” 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:3000 访问

切换目录

# cd /usr/local/mongodb/bin/my-yapi/

启动服务器

# node vendors/server/app.js 

或者 以守护进程启动

# node vendors/server/app.js &

打开http://127.0.0.1:3000 访问
记得开3000端口,重启防火墙!!!

very good!!!

使用yapi

使用默认账号登录
账号:admin@admin.com
密码:ymfe.org

只有超级管理员可以管理分组

创建分组

创建新项目

部分接口预览


其中还有Mock地址等,前端直接访问。爽歪歪的,后端不管功能有没有做好,只要把接口定义好了,前端可以直接对比着开发。多爽,再也不用和前端说话了。/滑稽

新成员加入

当技术老大,也就是admin把项目弄好, 所有开发都可以页面注册账号,然后查看接口和维护接口了。

所有成员注册账号

然后管理员把他们都拉近项目组


此时所有成员都可以看到接口啦。
登录成员账号查看

安装浏览器插件

其实写完接口的同时,可以直接进行浏览器访问本地服务,进行测试,就好比postman接口自测一样。

这个可以直接点击截图里面的教程,安装浏览器插件

此时本地启动我的项目(这个是前几篇写微服务写的,拿来用用)

测试一个 get请求user/test


直接省去了postman。哈哈

数据导出

如果项目开发完,是备份也好,是给别人看也好,还是第三方使用也好,直接导出!

导出效果查看

其实还有好多的功能,没有完全写到。慢慢体会吧。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Yapi的安装与使用 的相关文章

随机推荐

  • 基于规则的错别字改错

    利用ahocorasick库调用AC自动机寻找已经定义的错别字 不进行分词 并输出错别字开始位置和结束位置 并且在原文中进行改正 import ahocorasick def correct typos text typos 构建 AC 自
  • 字符串排序(函数,指针)(C语言实现)

    编写程序 用户输入n个 n lt 100 字符串 每个字符串长度小于100 按照字典顺序将字符串进行排序 并输出 要求在排序中使用指针数组完成 输入说明 输入第一行是一个整数数字 表示n 接下来有n行字符串 表示待排序字符串 输出说明 输出
  • 虚拟现实期末考试

    考点 考试分比 考试题型单项选择题40 名词解释题10 简答题20 程序设计题8 综合题12 材料分析题10 等 选择题 名词解释 VR 虚拟现实技术 英文名称 Virtual Reality 缩写为VR 是20世纪发展起来的一项全新的实用
  • linux sudo su - 免密配置

    添加用户 sudo useradd d home awen m s bin bash awen 添加用户切换root免密配置 echo awen ALL ALL NOPASSWD ALL gt gt etc sudoers d 90 clo
  • 如何更改电脑开机密码

    以我的电脑为例 是Windows 10系统的笔记本电脑 想要重新设置开机密码 相信大家都有想重新设置密码的冲动 网上也有对应的教程 但是很多人都有一个疑问 为什么根据教程来修改却没有成功 或者是重新登录电脑发现密码根本没有变化 其实不然 这
  • 技术进化对风险隔离与屏蔽超过民众想象

    刷脸支付公众在收获着消费便捷快感的同时 更多地则对刷脸支付的安全性与风险性提出了质疑 与指纹 虹膜等相比 人脸具有弱隐私性的生物特征 而且正是由于手机这一介质的缺失 人脸信息的克隆与利用也会变得 更加容易 相应地 用户使用刷脸支付的风险也就
  • Linux系统卡在iscsi服务导致无法正常开机

    现象 存储网络断开了 机器再开机时卡在开机logo去挂载iscsi 导致没法正常开机 解决办法 1 进救援模式或者单用户模式 将iscsid服务开机自启关了并禁用 关闭自启可能还是存在会被唤醒的情况 systemctl disable is
  • Maven项目的两种打包方式-spring-boot-mavne-plugin/maven-jar-plugin

    Maven项目的两种打包方式 spring boot mavne plugin maven jar plugin 1 前言 Maven的两种打包方式 2 流程图 3 spring boor maven plugin打包 4 maven ja
  • Java架构师的10个学习经验分享,初学者必看

    从零基础学习Java 只要方法正确 依然可以学好Java编程 学习Java就像交朋友一样 要从陌生到熟悉再到铁杆搭档一生相伴的过程 随着深入的了解 你不但会发现学Java并不是和想象的那样无聊和困难 而且还有一些美妙之感 当然在拥有强大的技
  • SecureCRT8.5的下载、安装、注册、连接

    https blog csdn net qq 37233070 article details 120683434
  • 前端Blob文件导出

    前端Blob文件导出 前言 一 Blob是什么 二 axios 拦截器中做统一处理 三 页面全局封装下载组建 总结 前言 通过把blob转file对象的方法下载文件 一 Blob是什么 Blob 对象表示一个不可变 原始数据的类文件对象 B
  • 了解一下Java的日志体系

    目录 了解日子框架体系 分析日志框架如何转换 logback日志的集成 SpringBoot日志使用 常见的一些日志框架如 commons logging jar log4j jar sl4j api jar等 他们之间是存在一定关系的 在
  • mysql错误解决(2003、1045 2800)

    1 2003解决 在D mysql 5 7 26 winx64中新建文件夹data 在bin中进入cmd 运行 mysqld initialize 等一段事件后 重启mysql服务 2 1045 2800 在my ini加入skip gra
  • 【机器学习 & 深度学习】通俗讲解集成学习算法

    目录 集成学习 一 机器学习中的集成学习 1 1 定义 1 2 分类器 Classifier 1 2 1 决策树分类器 1 2 2 朴素贝叶斯分类器 1 2 3 AdaBoost算法 1 2 4 支持向量机 1 2 5 K近邻算法 1 3
  • Pytorch使用NN神经网络模型实现经典波士顿boston房价预测问题

    Pytorch使用多层神经网络模型实现经典波士顿boston房价预测问题 波士顿房价数据集介绍 波士顿房价数据集是一个经典的机器学习数据集 用于预测波士顿地区房屋的中位数价格 该数据集包含了506个样本 每个样本有13个特征 包括城镇的各种
  • Vscode配置已有工程及自动格式化

    这里写目录标题 前言 配置CMake 配置clang clang tidy clang format clangd clang tidy clang format 前言 最近一直在用vscode写代码 发现vscode一旦配置好了真的好用
  • vue3.0 nextTick

    将回调推迟到下一个DOM更新周期之后执行 在更改了一些数据以等待DOM更新后立即使用它 import createApp nextTick from vue 方式一 const app createApp setup const chang
  • Error: ER_NOT_SUPPORTED_AUTH_MODE: Client does not support authentication解决办法

    node连接数据库报错 Error ER NOT SUPPORTED AUTH MODE Client does not support authentication protocol requested by server conside
  • sqlite3 数据同步

    在一个小项目中 用到 sqlite3 需要同步两个表 懒得装工具 写了两个函数搞掂 贴代码出来给需要的朋友 encoding utf 8 author 陈年椰子 contact hndm qq com version 1 0 file wo
  • Yapi的安装与使用

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