服务器部署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:9000，35.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

导入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，转换后的文档并不能完整无误的导入，还是会有部分接口存在些许的问题，还要手动再编辑跳转一下。

欢迎小伙伴们在下方评论区留言 ~ O(∩_∩)O
文章对我有帮助, 点此请博主吃包辣条 ~ O(∩_∩)O