Yapi:别再使用swagger了,这款api文档文档工具更适合中国开发宝宝的体质

YApi 是什么？

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。本文将带领大家搭建 YApi 接口平台

YApi 的 特点

• 权限管理： YApi 拥有比较成熟的团队管理扁平化项目权限配置，它可以满足各类企业的需求
• 可视化接口管理： 使用 websocket 技术开发的多人协作接口编辑功能，让多人协作 成倍提升开发效率
• Mock Server： 简单快捷的 Mock Server 应用， mock 数据的生成非常方便
• 自动化测试： 比较完善的接口自动化测试,保证数据的正确性
• 数据导入： 支持导入 Swagger, Postman, Har 数据格式，方便迁移旧项目
• 插件机制： 比较强大的插件机制，它可以满足各类业务需求

官方文档

ymfe.org

搭建YApi

当然前提是你的服务器安装有 Docker

创建 MongoDB 数据卷

docker volume create mongo_data_yapi

启动 MongoDB

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

获取 YApi 镜像

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

初始化 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

cd  /var/lib/docker
mkdir  api
touch config.json

config.json

{
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "test1",
"pass": "test1",
"port": "3000",
"adminAccount": "admin@admin.com",
"host": "smtp.163.com",
"port": 465,
"from": "  @163.com",   "db": {   "authSource": ""   },   "mail": {   "enable": true,    "auth": {   "user": "  @163.com",
"pass": " * "
  }
 }
}

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

curl 127.0.0.1:3000

访问YApi

• 登录账号 admin@admin.com
• 密码 ymfe.org

访问 Yapi

插件使用

1. idea插件搜索easyapi
2. 选中需要导出接口的控制层controller,右键
3. 
4. 在导出过程中需要在弹窗中配置一下项目的token,也可进入设置中进行配置
5. 
6. token获取方式
7. 
8. 导出成功后接口就在这个地方
9.