yapi接口管理系统搭建

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

浏览器访问

http://127.0.0.1:3000/

账号为:admin@admin.com 默认密码:ymfe.org

如果想自定义默认的超级管理员的用户名,直接在docker-compose.yml文件中修改 - ADMIN_EMAIL=admin@admin.com
这个属性就好了,密码要修改的话,就登录以后去控制台里面修改吧。

下面上一个我搭建成功的图:
在这里插入图片描述

具体的使用请去Yapi官网查看:https://hellosean1025.github.io/yapi/documents/index.html
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值