接口管理文档Yapi的安装与配置

发布于:2025-02-10 ⋅ 阅读:(42) ⋅ 点赞:(0)

YApi 是一个开源的 API 管理平台,由去哪儿网(Qunar)的移动架构组(YMFE)开发。它旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。YApi 提供了一系列强大的功能,包括接口文档管理、接口模拟、接口测试、团队协作等,使得 API 的开发、维护和测试更加高效和便捷。总的来说,YApi 是一个功能强大、易用性高的 API 管理平台,能够有效地提高开发效率,优化接口管理流程。同时它可以兼容多个工具的接口文档一次性导入,包括Postman、Swagger等,下面从部署开始到使用逐一做讲解介绍。
在这里插入图片描述

部署Yapi接口管理工具

创建数据卷根目录

mkdir -p /root/installs/yapi/{mongo,vendors}

创建Yapi数据存储库

docker run -d \
  --name mongo-yapi \
  -v /root/installs/yapi/mongo:/data/db \
  -e MONGO_INITDB_ROOT_USERNAME=admin \
  -e MONGO_INITDB_ROOT_PASSWORD=admin \
  "www.ecnfo.com:1443/proxy/mongo:4.2.5"

在根目录创建Yapi授权文件(vim config.json)用于配置Yapi端口、账号和mongo存储库端口、账号等信息

一般情况只需要修改json的第一级字段adminAccount和port即可,其它信息根据自己的情况修改即可

{
  "port": "3000",
  "adminAccount": "admin@yapi.com",
  "timeout":120000,
  "closeRegister":true,
  "db": {
    "servername": "mongo",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "admin",
    "pass": "admin",
    "authSource": "admin"
  }
}

为了安全起见,其中"closeRegister":true表示禁用注册,禁用注册后不论通过用户头像下拉列表中的[添加用户]还是通过下面api方式添加都会失败

curl http://192.168.3.109:3000/

网站公告

今日签到

点亮在社区的每一天
去签到