Windows安装yapi

本文介绍YAPI,一款专为开发、产品、测试人员设计的接口管理工具,支持轻松创建、发布与维护API及自动化生成文档。涵盖安装配置流程、默认账户密码与IDEA插件使用。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

安装工具

版本管理工具Git
Mongodb
Node和npm

文档地址

https://hellosean1025.github.io/yapi/

yapi介绍

旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。
以及自动化生成接口文档。

本地开发(可视化部署) 有网络要求的情况下

npm install -g yapi-cli --registry https://registry.npm.taobao.org  
yapi server

完成提示浏览器打开127.0.0.1:9090进行yapi配置。等待配置完成之后,根据页面提示。
根据提示在yapi本地安装路径下找到D: my-yapi /vendors/server/目录下,此目录下打开cmd 输入命令 ,

node  app.js

运行成功!
在这里插入图片描述
根据提示打开127.0.0.1:3000即可使用。(3000端口尽量留给它)
在这里插入图片描述

默认账户密码

账号admin@admin.com
密码ymfe.org

Idea配置

插件里搜索下载idea-yapi
配置yapi
主要配置项目projectToken、yApiUrl
选中controller类上的函数名,然后右键菜单中选择“idea-yapi”就OK!

### 在 Windows 上通过 Docker 部署和运行 YAPI 要在 Windows 系统上部署并运行 YAPI,需完成以下几个方面的配置: #### 1. 安装必要工具 在开始之前,需要确保已安装以下软件: - **Docker Desktop for Windows**: 可以从[Docker官网](https://www.docker.com/products/docker-desktop/)下载适用于 Windows 的版本。安装完成后,启用 WSL2 支持以便更好地兼容 Linux 容器。 - **Docker Compose**: 如果使用的 Docker 版本不自带 Compose 功能,则可以通过命令手动安装[^5]。 对于 Windows 用户来说,推荐直接使用最新版的 Docker Desktop,因为它已经集成了 Docker Compose 工具链。 #### 2. 创建 `docker-compose.yml` 文件 为了简化容器管理流程,可以创建一个 `docker-compose.yml` 文件来定义所需的服务。以下是适合于 YAPI 的基本配置示例: ```yaml version: '3' services: mongo: image: mongo:4.4 container_name: mongo-yapi restart: always environment: MONGO_INITDB_ROOT_USERNAME: admin MONGO_INITDB_ROOT_PASSWORD: admin volumes: - ./data/db:/data/db yapi: image: registry.cn-hangzhou.aliyuncs.com/anoy/yapi container_name: yapi-service ports: - "7001:7001" depends_on: - mongo entrypoint: ["npm", "run", "install-server"] working_dir: /api/vendors links: - mongo:mongo environment: REGISTRY_MONGODB_URI: mongodb://admin:admin@mongo:27017/yapi?authSource=admin ``` 此文件描述了一个 MongoDB 数据库实例以及基于该数据库构建的 YAPI 应用程序服务。注意端口映射部分 (`ports`) 将主机上的 7001 映射到容器内的相同端口号[^1]。 #### 3. 启动服务 保存上述 YAML 文件至任意目录下(比如命名为 `yapi-docker-compose.yml`),打开 PowerShell 或 CMD 并切换至此路径,执行如下指令启动所有关联的服务: ```bash docker-compose up -d ``` 这条命令会以后台模式拉取镜像、建立网络连接并且开启指定的服务进程。 如果遇到工作目录错误提示类似于 “the working directory is invalid”,请确认当前操作系统的绝对路径设置无误,并且避免混用 Git Bash 这类可能改变默认行为的 shell 终端[^3]。 #### 4. 访问 Web 界面 一旦成功启动之后,就可以通过浏览器访问地址 http://localhost:7001 来进入 YAPI 控制面板界面[^4]。 --- ### 注意事项 - 若首次运行时发现缺少某些依赖项或者报错无法正常加载页面,请尝试重新 pull 最新的官方镜像资源后再试一次。 - 对于生产环境中建议调整更多参数选项如持久化存储位置等进一步优化性能表现。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

勤快的小蚂蚁

奖励下我呗!

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值