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

作者: Anoyi | 来源:发表于2018-04-05 11:26 被阅读4489次

前言介绍

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 镜像,版本信息可在 阿里云镜像仓库 查看

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

4、初始化 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,官方自定义配置文件 -> 传送门

5、启动 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

相关文章

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

    前言介绍 Yapi 由 YMFE 开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建...

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

    前言介绍 Yapi由 YMFE 开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、...

  • YAPI 速记

    YAPI[https://github.com/YMFE/yapi] 是一个不错的 API WEB集成管理工具,目...

  • Yapi 导出精美html的接口文档

    之前公司使用Yapi(我的建议,哈哈)来管理API,但是公司要求提供API文档方便与其他项目组对接。好在Yapi提...

  • 更优雅的接口文档编写方式 — YApi

    背景 系统开发过程中,必然少不了文档,而在互联网应用系统开发中,API接口文档则更是必不可少。 YApi YApi...

  • Api文档管理工具Yapi的搭建

    1.安装并启动MangoDB 2.安装YAPI 3.修改默认配置 4.安装依赖 5.初始化 6.启动服务 7.浏览器验证

  • Swagger,SpringBoot,SpringMVC,Yap

    背景 我们公司接口管理工具用的是Yapi,但是Yapi还是需要后端开发人员分配较多额外的精力去维护接口文档的信息,...

  • k3s部署yapi启用ldap

    介绍 yapi是api 文档管理系统,基于nodejs和mongodb。集成ldap 编写entrypoint,s...

  • 本地/内网搭建api文档管理工具

    标题:本地/内网搭建api文档管理工具关键字:api、api文档管理、post作者:puakil 本地环境: 1....

  • k3s部署yapi v3

    介绍 yapi是api 文档管理系统,基于nodejs和mongodb。官方没有提供标准的docker镜像都是自己...

网友评论

  • 程序熊大:👍👍👍,跟东哥学习新姿势,很好用
    程序熊大:@Anoyi 我部署了一个自己先试用下,还没推
    Anoyi:@杜琪 你们也用啦?
  • _Mr丶s:有没有在linux上搭建详细教程求
    Anoyi:@_Mr丶s 只要装docker就行
    _Mr丶s:@Anoyi 我看需要装nodejs和mongdb
    环境
    Anoyi:@_Mr丶s linux 通用啊
  • 柳言飞:yapi 更新版本啦
    Anoyi:好的 现在更新 哥
  • 三月的一整个月:能把API,以文档的形式生成下载下来吗?
  • alonwang:是自动生成api文档的吗
    Anoyi:@alonwang 不是哦
  • beiou315:确实是一款良心产品。给了我很多思路。
    Anoyi:@beiou315 替作者谢谢你:smiley:
  • 流水理鱼:非常棒
    Anoyi:@理鱼 谢谢
  • 疯婆子小迪:你好,现在yapi已经更新至1.3.16,镜像可以更新一下嘛:blush:
    Anoyi:@疯婆子小迪 已更新到 1.3.22 了,你拉下最新的就好了
  • 我只是一个小白木木:你好 1.1.17的docker镜像存在bug 麻烦更新下最新的YPAI,光芳说这个bug他们已经解决了
    我只是一个小白木木:我中午下载的最新版本 出现报错 在编辑返回数据格式的时候,输入任何字符都会附带一个1而且使用Backspace键删除所输入字符时会出现该字段已经存在的错误提醒
    Anoyi:@我只是一个小白木木 昨天就更新了,文档没更,多谢提醒
    我只是一个小白木木:@我只是一个小白木木 1.3.17
  • c6c2239958da:请问mongodb是否可以用其他server上的?配置docker的话,应该加什么参数,谢谢!
    Anoyi:@Ricky_2347 前提是你要对docker 比较熟悉,不熟的话,直接原生安装 Mongo 吧,然后改下 yapi 的连接配置,一样可以用
    c6c2239958da:@Anoyi 启动docker时应该加什么参数?
    Anoyi:@Ricky_2347 可以
  • 皮蛋XXXXL:能不能告知默认mongo连接账号密码。 使用官方实例的config.json连不上, 会报验证错误, 创建了test1账号仍然不行
    皮蛋XXXXL:@Anoyi 能发一下docker里面的config.json吗?我只是想增加个邮箱配置, 并不是想修改账号密码。
    Anoyi:@皮蛋XXXXL 用docker起的没有帐号密码
    皮蛋XXXXL:docker run -d \
    --name yapi \
    --link mongo-yapi-3.4.15:mongo \
    --workdir /api/vendors \
    -v /opt/yapi/config.json:/api/config.json \
    -p 3000:3000 \
    registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
    server/app.js
  • 千若逸:这个没有将Docker中数据目录映射到本地机器上,一旦重启Docker数据,数据就会丢失吧
    Anoyi:@千若逸 嗯,不清楚的可以互相交流
    千若逸:@Anoyi 原来-v就是volume,那就说得通了,学艺不精很抱歉
    Anoyi:@千若逸 数据存储在 MongoDB
  • 一个玩Odoo的小伙:小白一个,请问我做python相关开发,能用yapi吗 主要是用来干啥的
    Anoyi:@__Create__ yapi的交互体验还是可以的
    一个玩Odoo的小伙:@Anoyi 收到,看了官网的介绍,真的是一头雾水。最近使用gitbook,感觉使用md的文档管理也很不错 🙃
    Anoyi:@__Create__ 后端接口文档管理
  • 我只是一个小白木木:作者很棒,勤劳的小蜜蜂!
  • fudali:你好,介意公布一下dockerfile么?貌似没有看到相关的地方有
    7886448bb1d0:@Anoyi https://github.com/Wyntau/docker-yapi 这里有一个, 和LZ的不一样, 可以看下配置.
    比LZ的镜像更小.
    胖权:能否将敏感的信息的注释掉,公布下dockerfile,学习下
    Anoyi:@fudali 改了点东西,不太好公布
  • 3143dd0a6b11:@Anoyi 内网可以远程调吗?这个报错主要是什么原因呢
    3143dd0a6b11:@Anoyi 可以连外网 可以加个QQ吗
    Anoyi:@饭桶菇凉_5dd0 还有你这个镜像的id是什么
    Anoyi:@饭桶菇凉_5dd0 能连外网吗?
  • 3143dd0a6b11:内网部署 没有从阿里仓库直接pull 如何启动服务呢
    Anoyi:@饭桶菇凉_5dd0 用的是docker启动的呀
    3143dd0a6b11:部署yapi平台 必须安装mangodb吗 我看您写的第一步骤就直接创建mangodb数据卷以及启动了 在这之前需不需要安装mangodb呢
    Anoyi:@饭桶菇凉_5dd0 看yapi官方文档,下载他们的源码
  • 我只是一个小白木木:有时间把镜像升级成最新版本吗? v1.3.12
    Anoyi:@zt洛洛猪 已更新
    Anoyi:@zt洛洛猪 下午2点前弄好
  • 我只是一个小白木木:你好请问4、初始化 Yapi 数据库索引及管理员账号 和5 这两部我直接复制使用报错
    [root@centos7 ~]# docker run -it --rm \
    > --link mongo-yapi:mongo \
    > --entrypoint npm \
    > --workdir /api/vendors \
    > yapi \
    > run install-server
    Unable to find image 'yapi:latest' locally
    Trying to pull repository docker.io/library/yapi ...
    /usr/bin/docker-current: repository docker.io/yapi not found: does not exist or no pull access.
    See '/usr/bin/docker-current run --help'.
    [root@centos7 ~]# docker run -it --rm --link mongo-yapi:mongo --entrypoint npm --workdir /api/vendors yapi
    Unable to find image 'yapi:latest' locally
    Trying to pull repository docker.io/library/yapi ...
    /usr/bin/docker-current: repository docker.io/yapi not found: does not exist or no pull access.
    See '/usr/bin/docker-current run --help'.
    我只是一个小白木木:@Anoyi 我的QQ442104804 希望能得到你的帮助 非常 万分的感谢您!:pray:
    我只是一个小白木木:@Anoyi 嗯是的 已经解决了,可是目前又遇到了一个问题 如果我服务器重启以后 运行docker,怎么再次运行mongo 和yapi啊 我试了运行不起来,因为我是小白
    Anoyi:@zt洛洛猪 第三步有个重新 tag 的操作你没处理
  • cooling2016:又见大神,好6的平台
    Anoyi:@cooling2016 这个不是我写的啊,只是做了个镜像
  • sean_8b84:写的非常好
    Anoyi:@sean_8b84 :pray:
  • 暴风鸟:前来点赞

本文标题:顶尖 API 文档管理工具 (Yapi)

本文链接:https://www.haomeiwen.com/subject/visrhftx.html