顶尖 API 文档管理工具 (Yapi)

96
Anoyi
5.0 2018.04.05 11:26* 字数 204

▶ 使用 Docker 构建 Yapi

1、启动 MongoDB

docker run -d --name mongo-yapi mongo

2、获取 Yapi 镜像,版本信息可在 阿里云镜像仓库 查看

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

3、初始化 Yapi 数据库索引及管理员账号

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server

自定义配置文件挂载到目录 /api/config.json,官方自定义配置文件 -> 传送门

4、启动 Yapi 服务

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js

▶ 使用 Yapi

访问 http://localhost:3000 登录账号 admin@admin.com,密码 ymfe.org

至此,帅气的 Yapi 就可以轻松使用啦!更多文档信息,请参考

▶ 其他相关操作

关闭 Yapi

docker stop yapi

启动 Yapi

docker start yapi

升级 Yapi

# 1、停止并删除旧版容器
docker rm -f yapi

# 2、获取最新镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

# 3、启动新容器
docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js

▶ 手动构建 yapi 镜像

1、下载 YAPI 到本地

wget -o yapi.tar.gz https://github.com/YMFE/yapi/archive/v1.8.0.tar.gz

下载地址:https://github.com/YMFE/yapi/releases

2、编辑 Dockerfile

FROM node:12-alpine as builder

RUN apk add --no-cache git python make openssl tar gcc

COPY yapi.tar.gz /home

RUN cd /home && tar zxvf yapi.tar.gz && mkdir /api && mv /home/yapi-1.8.0 /api/vendors

RUN cd /api/vendors && \
    npm install --production --registry https://registry.npm.taobao.org

FROM node:12-alpine

MAINTAINER 545544032@qq.com

ENV TZ="Asia/Shanghai" HOME="/"

WORKDIR ${HOME}

COPY --from=builder /api/vendors /api/vendors

COPY config.json /api/

EXPOSE 3000

ENTRYPOINT ["node"]

3、构建镜像

docker build -t yapi .
架构