1)下载安装
我们是基于docker进行安装,下载直接使用docker pull docker pull 即可
由于yapi使用mongo数据,所以需要先安装mongo
docker pull mongo
docker pull registry.cn-hangzhou.aliyuncs.com/anoyi/yapi
2)YAPI简介
YAPI是开发、产品、测试人员提供更优雅的接口管理服务。
功能:
帮助开发者轻松创建、发布、维护 API。
自动化生成接口文档。
3)docker安装yapi
拉取yapi镜像文件
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
创建数据存储目录
mkdir -p /home/data/yapi/mongodata
使用专用mongodata存储yapi数据:
docker run --restart always -v /home/data/yapi/mongodata:/data/db -d --name yapimongo mongo
4)yapi启动和配置
初始化yapi镜像参数
docker run -it --rm --link yapimongo:mongo --entrypoint npm --workdir
/api/vendors
registry.cn-hangzhou.aliyuncs.com/anoy/yapi
run install-server
启动yapi镜像
使用3001端口进行启动,并跟随docker启动。
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
登陆
输入: http:\ip:3001 进入系统。
初始化管理员账号成功,账号名:“admin@admin.com”,密码:“ymfe.org” 。
5)Docker-compose配置
docker-compose.yml文件
version: ‘2’
services:
mongo-yapi:
image: mongo
container_name: mongo-yapi
privileged: true
mem_limit: 1024M
restart: always
ports:
- “27017:27017”
restart: always
volumes:
- ./mongo-yapi/data:/data/db
environment:
MONGO_INITDB_ROOT_USERNAME: anoyi
MONGO_INITDB_ROOT_PASSWORD: anoyi.com
MONGO_INITDB_DATABASE: yapi
networks:
yapinet:
ipv4_address: 192.168.22.10
Yapi:
image: yapi
container_name: yapi
volumes:
- ./config.json:/api/config.json
restart: always
entrypoint: npm
working_dir: /api/vendors
ports:
- “3000:3000”
command: run install-server #第一次启动使用
#command: “node /yapi/vendors/server/app.js”
networks:
yapinet:
ipv4_address: 192.168.22.11
networks:
yapinet:
external:
name: ex-yapinet
添加执行文件startup.sh
tarpath=“$(cd dirname $0
; pwd)”
docker network create --subnet=192.168.22.1/24 ex-yapinet
docker-compose -f ${tarpath}/docker-compose.yml up -d --build
执行过程中发现mongo可以正常,但yapi怎么都起不来,后来只能使用docker命令实现,后续再行优化 (mongodb直接使用docker-compose编排好的)
docker run -it --rm
–network ex-yapinet
–link mongo-yapi:mongo
–entrypoint npm
–workdir /api/vendors
-v /home/_docker/dev-env/yapi/config.json:/api/config.json
registry.cn-hangzhou.aliyuncs.com/anoy/yapi
run install-server
初始化管理员账号成功,账号名:“admin@admin.com”,密码:“ymfe.org”
初始化管理员账号成功,账号名:“admin@anoyi.com”,密码:“ymfe.org”
docker run -d
–name yapi
–network ex-yapinet
–link mongo-yapi:mongo
–workdir /api/vendors
-v /home/_docker/dev-env/yapi/config.json:/api/config.json
-p 3000:3000
registry.cn-hangzhou.aliyuncs.com/anoy/yapi
server/app.js
6)Mongo客户端工具
选用robo3t工具