# yapi-docker-compose

**Repository Path**: psvmc/yapi-docker-compose

## Basic Information

- **Project Name**: yapi-docker-compose
- **Description**: yapi 1.12.0 构建
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-31
- **Last Updated**: 2025-10-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# YApi Docker Compose

本项目提供了一种便捷的方式来部署 [YApi](https://github.com/YMFE/yapi)，一个高效、易用、支持可视化的接口管理平台。通过 Docker 和 Docker Compose，您可以快速启动 YApi 服务及其依赖项。

## 功能特点

- 快速部署 YApi 服务
- 支持通过 Docker Compose 一键启动
- 包含 MongoDB 初始化脚本
- 支持自定义配置

## 目录结构

- `Dockerfile`：构建 YApi Docker 镜像的配置文件。
- `docker-compose.yml`：定义 YApi 和 MongoDB 服务的编排文件。
- `mongo-conf/init-mongo.js`：MongoDB 初始化脚本，用于创建 YApi 所需的数据库和用户。
- `run_yapi.sh`：启动 YApi 服务的脚本。
- `yapi-conf/config.json`：YApi 的配置文件，可以自定义配置信息。
- `.gitignore`：指定 Git 忽略的文件和目录。

## 安装与使用

### 前提条件

- 安装 [Docker](https://www.docker.com/)
- 安装 [Docker Compose](https://docs.docker.com/compose/)

### 启动服务

1. 克隆本仓库：

   ```bash
   git clone https://gitee.com/psvmc/yapi-docker-compose.git
   cd yapi-docker-compose
   ```

2. 启动服务：

   ```bash
   docker-compose up -d
   ```

3. 访问 YApi：

   打开浏览器，访问 `http://localhost:3000`，即可使用 YApi。

## 配置

您可以根据需要修改 `yapi-conf/config.json` 文件来调整 YApi 的配置，例如数据库连接信息、端口等。

## 贡献

欢迎贡献代码和建议。请提交 Pull Request 或 Issue 到本项目。

## 许可证

本项目遵循 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。