前言
大部分项目 api 文档还是使用 swagger 或者 apifox,今天接触到一个新的 api 文档项目,感觉还挺不错的,部署一下玩玩。
项目地址
它自己的介绍:
旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API
功能还是挺强大的:
部署
其实是有 docker 的,但是我看更新频率很低:
5 个月没更新了~而且我看官网的部署也没有关于 docker 方式的部署,所以就算了,官网推荐是 npm 方式,所以机器必须有 node 环境,
我们就用它推荐的可视化部署来吧~
需要准备 mongodb,直接 docker 跑一个吧~(推荐 mongo:4.4 高版本需要特殊指令,有些机器可能没有)
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
输入 IP:9090
根据实际情况填写一下,点击开始部署~
部署完成之后,会显示你的账号密码等信息,记录一下~
然后会让你进入部署目录执行:
node vendors/server/app.js
可以写一个启动脚本:start-yapi-server.sh,内容如下:
#/bin/bash
nohup node vendors/server/app.js &
赋予可执行权限:
chmod +x start-yapi-server.sh
启动服务:
./start-yapi-server.sh 即可
启动之后,打开 IP:3000 方法即可~
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于