YApi--接口文档部署与使用
部署
采用docker部署的方式
部署mongo来存储yapi接口数据
mkdir -p /home/mount/mongdb/data
docker run -d --name mongo --restart=always -p 27017:27017 \
-v /home/mount/mongdb/data:/data/db \
-e MONGO_INITDB_ROOT_USERNAME=root \
-e MONGO_INITDB_ROOT_PASSWORD=zhcf1234 --privileged=true mongo
启动yapi
添加配置文件
mkdir -p /home/mount/mongdb/config;
vim /home/mount/mongdb/config/config.json
> 在文件中添加以下的配置
{
"port": "3000",
"adminAccount": "admin@zhcf.com",
"timeout":120000,
"db": {
"servername": "mongo",
"DATABASE": "yapi",
"port": 27017,
"user": "root",
"pass": "zhcf1234",
"authSource": "admin"
}
}
启动
docker run -it --rm --link mongo:mongo --entrypoint npm --workdir /yapi/vendors -v /home/mount/mongdb/config/config.json:/yapi/config.json registry.cn-hangzhou.aliyuncs.com/anoyi/yapi run install-server
访问
http://ip:3000
用户名:admin@zhcf.com 密码:ymfe.org
部署成功界面
创建项目
创建temp项目,进入设置页面保存项目token方便后面使用
idea中的使用
安装EasyYapi插件
配置yapi的地址
发布文档到yapi
发布成功
注意:本文归作者所有,未经作者允许,不得转载