【Tools】API文档管理工具YApi的安装以及使用

最新推荐文章于 2024-05-26 09:42:25 发布

Darren Gong

最新推荐文章于 2024-05-26 09:42:25 发布

阅读量646

点赞数

分类专栏：工具文章标签： docker YApi api管理平台

本文链接：https://blog.csdn.net/axin1240101543/article/details/108262189

版权

工具专栏收录该内容

6 篇文章 0 订阅

订阅专栏

一、什么是YApi

1、简介

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

avatar

2、github

https://github.com/YMFE/yapi

3、特性

基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
支持 postman, har, swagger 数据导入
免费开源，内网部署，信息再也不怕泄露了

4、版本更新

https://github.com/YMFE/yapi/blob/master/CHANGELOG.md

二、docker的安装（CentOS版本：CentOS Linux release 7.7.1908）

1. 安装docker

yum install docker

2. 启动 docker 服务

service docker start

3. 设置为开机启动

chkconfig docker on

4. 配置Docker加速器

使用阿里镜像加速：https://cr.console.aliyun.com

vi /etc/docker/daemon.json

{
"registry-mirrors": ["***"]
}

sudo systemctl daemon-reload
sudo systemctl restart docker

5. 重新启动 docker 服务

service docker restart

6. 查看docker版本

docker version

二、安装YApi

1、启动MongoDB

docker run -d --name mongo-yapi mongo

2、获取YApi 镜像

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

3、初始化YApi数据库索引及管理员账号

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server

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

5、启动YApi

docker start yapi

6、停止YApi

docker stop yapi

7、升级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