Yapi安装手册

版本号

  • Yapi:v1.9.2

  • MongoDB:v4.4.2

  • Node.js:v12.20.0

  • Git:v1.8.3.1

 编辑

配置MongoDB

  • 安装过程参考

  • 下载MongoDB压缩包,下载地址
    wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.4.2.tgz
  • 解压
    tar -xvf mongodb-linux-x86_64-rhel70-4.4.2.tgz
  • 安装依赖
    yum install libcurl openssl xz-libs
  • 创建文件链接
    ln -s /path/to/the/mongodb-directory/bin/* /usr/local/bin/
  • 创建数据及日志文件夹
    mkdir /var/lib/mongo
    mkdir /var/log/mongodb
  • 启动
    mongod --dbpath /var/lib/mongo --logpath /var/log/mongodb/mongod.log --bind_ip xxx.xxx.xxx.xxx --fork

 编辑

安装Node.js

  • 安装过程参考

  • 下载Node.js压缩包,下载地址
    wget https://nodejs.org/dist/v14.15.3/node-v14.15.3-linux-x64.tar.xz
  • 解压
    tar -xvf node-v14.15.3-linux-x64.tar.xz
  • 创建文件链接
    ln -s /usr/local/nodejs/bin/npm /usr/local/bin/
    ln -s /usr/local/nodejs/bin/node /usr/local/bin/
  • 测试是否安装成功
    node -v

 编辑

安装Yapi

  • 安装过程参考参考

  • 使用npm安装Yapi
    npm install -g yapi-cli --registry https://registry.npm.taobao.org
  • 进入Node.js安装目录,启动
    bin/yapi server
  • 浏览器访问9090端口,进入可视化部署程序页面,根据实际信息填写

  • 点击开始部署

  • 启动服务
    node vendors/server/app.js
  • 访问3000端口,使用管理员账号密码登陆即可

  • 利用pm2进行服务管理
    npm install pm2 -g  //安装pm2
    cd  {项目目录}
    pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
    pm2 info yapi //查看服务信息
    pm2 stop yapi //停止服务
    pm2 restart yapi //重启服务
  • 部署时报错解决方法

    • 'Accessing non-existent property 'count' of module exports inside circular dependency'

    • 提示init.lock文件已存在,无法初始化

      • 初始化完成后会生成init.lock文件,若重新初始化需删除此文件以及清空MongoDB中已生成的项目配置信息。

 编辑

Yapi使用

  • 详细使用教程可参考

  • Yapi接入swagger文档,参考

03-08
### YAPI API文档管理平台介绍 YAPI 是一个功能强大、易于使用的接口管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务[^3]。该平台不仅涵盖了接口的创建、调试、测试以及文档生成等功能,还利用 Docker 容器化技术实现了便捷的跨操作系统部署和运行能力,极大地提升了团队协作和个人开发者的工作效率[^1]。 #### 平台特性概述 - **全面的功能覆盖**:支持从定义到发布的整个生命周期内的各项操作; - **高效的团队合作工具**:促进不同角色之间的沟通交流,减少误解误判的可能性; - **自动化程度高**:自动生成详细的 RESTful 或 GraphQL 风格的 API 文档,并能实时更新维护; - **灵活的数据模拟(Mock)**:允许快速构建虚拟的服务端响应来加速前端开发进度; ```json { "name": "User", "description": "用户信息查询接口", "method": "GET", "path": "/api/user/:id" } ``` 这段 JSON 片段展示了如何描述一个简单的 GET 请求路径 `/api/user/:id` 的基本信息,在实际应用中还可以加入更多细节如参数说明、返回值结构体等。 ### 使用教程 为了更好地理解 YAPI 的工作原理及其具体应用场景,下面将以几个典型场景为例来进行简单演示: #### 创建新项目与导入已有 API 列表 进入 YAPI 后可以通过点击左侧菜单栏中的“新建分组”,输入名称后保存即可完成项目的建立过程。对于已经存在的 API 文件,则可以选择批量上传的方式将其转换成可编辑的状态供后续处理。 #### 编辑单个 API 接口详情页 当需要修改某个特定接口的信息时,只需找到对应的记录并打开其专属页面就能看到所有关联字段等待完善补充。这里不仅可以调整 HTTP 方法类型(POST/PUT/PATCH)、URL 路径模式外,还能指定请求头设置、正文格式等内容。 #### 自动生成 API 文档 一旦完成了上述配置步骤之后,系统会自动依据设定好的模板渲染出一份美观大方且条理清晰的技术手册供查阅学习之用。此外也支持导出 PDF 格式的永久存档副本以便离线查看分享给其他相关人员审阅反馈意见。 #### 实施在线调用测试 除了静态展示之外更重要的是能够即时验证所编写逻辑是否正确无误。因此在每一个 API 记录下方都配备了一个简易版 Postman 类似的交互界面让用户轻松发起各种类型的网络请求从而直观感受预期效果的好坏差异之处。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值