顶尖 API 文档管理工具 (Yapi) | Spring For All

774 阅读1分钟
原文链接: www.spring4all.com

先发点小福利 :各种电子书免费下载,有书分享的欢迎联系我,补充到书架,共享资源,(^__^) 嘻嘻……

前言介绍

Yapi 由 YMFE 开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。

  • 权限管理
    YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求

  • 可视化接口管理
    基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率

  • Mock Server
    易用的 Mock Server,再也不用担心 mock 数据的生成了

  • 自动化测试
    完善的接口自动化测试,保证数据的正确性

  • 数据导入
    支持导入 swagger, postman, har 数据格式,方便迁移旧项目

  • 插件机制
    强大的插件机制,满足各类业务需求

去哪儿网移动架构组(YMFE)是由FE,iOS和Android工程师共同组成的,去哪儿最具想象力、创造力和影响力的大前端团队。

使用 Docker 构建 Yapi

1、创建 MongoDB 数据卷

docker volume create mongo_data_yapi

2、启动 MongoDB

docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo

3、获取 Yapi 镜像,并重新 tag

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

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

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

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  yapi \
  run install-server

5、启动 Yapi 服务

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  yapi \
  server/app.js

使用 Yapi

访问地址 http://localhost:3000

登录,账号 admin@anoyi.com,密码 anoyi.com

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