Yapi
Yapi是由去哪儿前段团队开发的一个接口管理系统,现在企业的项目一般都是前后端分离的,所以我们的接口都必须要写联调文档,做Java的同学都知道,java有个开源框架用来自动生成文档的丝袜哥
,我之前也用的是丝袜哥
,但是作为一个审美比较高的人来说,这个丝袜哥简直看不下去,太丑了。后面我就在github上面找到了这个Yapi,只能说界面做的非常哇塞,而且功能也非常强大,
支持本地部署,还支持在线测试呢。
Yapi官网:https://hellosean1025.github.io/yapi/documents/index.html
我这里直接贴出docker构建的脚本,如果机器上安装了docker的话,直接按照这个脚本就能快速将Yapi搭建起来,
搭建步骤:
- 在本地建一个文件夹,我们这里叫
yapi
- 在
yapi
文件夹创建一个docker-compose.yml
文件,注意这个文件名一定不能写错。 - 将下面这个脚本复制到
docker-compose.yml
中 - 在yapi文件夹的目录中,直接执行
docker-compose up -d
,等一会就能安装完成了
version: '2.1'
services:
yapi:
image: mrjin/yapi:latest
container_name: yapi
environment:
- VERSION=1.5.6
- LOG_PATH=/tmp/yapi.log
- HOME=/home
- PORT=3000
- ADMIN_EMAIL=admin@admin.com
- DB_SERVER=mongo
- DB_NAME=yapi
- DB_PORT=27017
restart: always
ports:
- 3000:3000
volumes:
- ./log/yapi.log:/home/vendors/log
depends_on:
- mongo
entrypoint: "bash /wait-for-it.sh mongo:27017 -- entrypoint.sh"
mongo:
image: mongo
container_name: mongo
restart: always
ports:
- 27017:27017
volumes:
- ./mongodb:/data/db
浏览器访问
账号为:admin@admin.com
默认密码:ymfe.org
如果想自定义默认的超级管理员的用户名,直接在docker-compose.yml
文件中修改 - ADMIN_EMAIL=admin@admin.com
这个属性就好了,密码要修改的话,就登录以后去控制台里面修改吧。
下面上一个我搭建成功的图: