本地部署YApi需要先安装nodejs和MongoDB,参考其他教程。本文使用docker安装,请先准备docker环境。
安装步骤
拉取yapi镜像
1、docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
创建本地文件夹,用于mongodb的数据存储,与docker容器做映射
2、mkdir -p /Users/lgtn/copy/study/yapi/mongodata
启动mongodb
3、docker run --restart always -v /Users/lgtn/copy/study/yapi/mongodata:/data/db -d --name yapimongo mongo
配置yapi
4、docker run -it --rm --link yapimongo:mongo --entrypoint npm --workdir /api/vendors registry.cn-hangzhou.aliyuncs.com/anoy/yapi run install-server
执行完后,会初始化管理员账号、密码
docker run -it --rm --link yapimongo:mongo --entrypoint npm --workdir /api/vendors registry.cn-hangzhou.aliyuncs.com/anoy/yapi run install-server
> yapi-vendor@1.8.5 install-server /api/vendors
> node server/install.js
log: mongodb load success...
初始化管理员账号成功,账号名:"admin@admin.com",密码:"ymfe.org"
启动yapi
5、docker run -d --restart=always --name yapi --link yapimongo:mongo --workdir /api/vendors -p 3001:3000 registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js
6、输入: http:\ip:3001 进入系统。
接口管理及测试
使用教程
官网:https://hellosean1025.github.io/yapi/documents/index.html
从Swagger导入接口
swagger接口地址需要使用json格式的,如:http://ip:port/v2/api-docs