服务器部署yapi,搭建api文档服务

2021-04-09 06:40:16   前端
  API   YAPI  

yapi是为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。本文会讲一下服务器部署yapi教程以及过程可能遇到的问题

环境要求

  • ubuntu (16+)
  • nodejs(7.6+)
  • mongodb(2.6+)
  • git

安装nodejs、npm、mongodb、git

apt install nodejs
apt install npm
apt install mongodb
apt install git

下载安装yapi

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

启动可视化部署

yapi server

(可能遇到的问题开始)

注:这里可能会遇到找不到node的问题,提示如下错误(若没遇到跳过):

/usr/bin/env: node: No such file or directory

其实,默认在/usr/bin下,有个nodejs,但执行的时候用的node,创建一个软连接即可:

ln -s /usr/bin/nodejs /usr/bin/node

(可能遇到的问题结束)

这时候,在浏览器访问127.0.0.1:9000就出现可视化部署界面了。

注:对于本机访问是127.0.0.1:9000,如果是访问内网ip,或者访问公网ip,换成相应的地址或域名即可,如:192.168.96.110:900035.78.112.114:9000,当然,如果是云服务器,大多都有防火墙,记得把9000端口打开。

填写完基础信息之后,便可以自动部署服务器了。

pm2管理

// 全局安装 pm2
npm install pm2 -g

// 配置pm2服务
pm2 start /apps/apidoc/vendors/server/app.js

// 使用
pm2 start yapi
pm2 stop yapi

登录

访问ip:端口,ip是服务器的ip,端口是可视化部署时填写的端口号,就进入登录注册界面了。

虽然管理员邮箱可以自己填,但没提供密码填写,默认密码是ymfe.org,登录后修改即可。

导入postman文件

yapi目前只支持postman的v1版本的导出文件,而目前postman只支持导出v2和v2.1版本的json文件,这里需要借助一个工具,将v2+版本的转为v1.

安装 postman-collection-transformer

npm install -g postman-collection-transformer

转换

postman-collection-transformer convert \
    --input ./v1-collection.json \
    --input-version 2.0.0 \
    --output ./v2-collection.json \
    --output-version 1.0.0 \
    --pretty \
    --overwrite

u1s1,转换后的文档并不能完整无误的导入,还是会有部分接口存在些许的问题,还要手动再编辑跳转一下。

viencoding.com版权所有,允许转载,但转载请注明出处和原文链接: https://viencoding.com/article/292
欢迎小伙伴们在下方评论区留言 ~ O(∩_∩)O
文章对我有帮助, 点此请博主吃包辣条 ~ O(∩_∩)O

猜你喜欢


评论

There are no comments yet.
未登录

登录后即可发表评论

登录或注册

标签

AdSense Anaconda Android apache API apt Auth AWS B-tree Bandwagon Blog bower brew bytes Caffe Catalina cloudcone Composer conda CoreML CPU crontab CSS csv Cuda cv2 datetime Digitalocean DNS Docker Docker-Compose Eloquent Excel export Flask FTP GET Git GitHub GitLab Gmail GoDaddy Google GTM hash Homebrew Homestead HTML http HTTPS IDEA image imagemagick imagick imgick import InnoDB ios iou iPhone ISO8601 iTerm2 Java JPG Keras Laravel Laravel-Admin lazyload Linux list lnmp load logs Lravel Mac Markdown matplotlib md5 mix MobileNet Mojave mongo MongoDB MySQL Namesilo Nginx Node npm numpy Nvidia Nvidia-Docker onevps OpenCV Openpose openpyxl Outline parse PayPal PHP php-fpm PhpStorm PHP扩展 PIL Pillow pip PNG POST Protobuf PyCharm pyenv pymongo Python Python,人工智能,机器学习,VOC,xml Queue Redis requests RGB Sanctum save selenium SEO Shadowsock Shadowsocks ShadowsocksR simplemde Spring Boot SQLServer ssd SSH SSL证书 SSR str Sublime sudo swap Swift Tensorflow TensorflowLite Terminal Terminator Ubuntu urllib UTC v2ray Valet Validation Validator VienBlog virtualenvs VPN VPS Vultr Web Windows WordPress Xcode xlsx yaml YAPI YUV zip zmq zsh 下载图片 主从同步 云主机 云服务器 人工智能 优化 优惠码 伪原创 作弊与反作弊 免费ss账号 免费提现 切片 前端 加密 协议 博客 友链 双击事件 后台运行 后端 命令 国内镜像源 图标 图片操作 图片转换 域名 多身份认证 大小写转换 姿态检测 安卓模拟器 安装 定时任务 定时执行 密码 密钥 导出导入 小程序码 延迟加载 微信 微信小程序 快捷方式 慢查询 懒加载 提现 搜索引擎 搬瓦工 搭梯子 教程 数据库 数据重复 文件上传 无法登录 日志 日期 时区 时间 时间戳 服务器 机器学习 权限 梯子 模拟浏览器 港版支付宝 漏洞 爬虫 生活服务 用户管理 病毒 登录 目标检测 科学上网 系统升级 索引 组件开发 编辑器 自动付款 自定义组件 英文伪原创 计划任务 计算机视觉 认证 语法 读写分离 远程连接 配置文件 重定向 错误异常 错误提示 队列 阿里云 香港 香港手机号
亲情非友情链接