# 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

This project provides a convenient way to deploy [YApi](https://github.com/YMFE/yapi), an efficient, user-friendly, and visualization-supported API management platform. Using Docker and Docker Compose, you can quickly start YApi and its dependencies.

## Features

- Rapid deployment of the YApi service
- One-command startup via Docker Compose
- Includes MongoDB initialization script
- Supports custom configuration

## Directory Structure

- `Dockerfile`: Configuration file for building the YApi Docker image.
- `docker-compose.yml`: Orchestration file defining the YApi and MongoDB services.
- `mongo-conf/init-mongo.js`: MongoDB initialization script to create the database and user required by YApi.
- `run_yapi.sh`: Script to start the YApi service.
- `yapi-conf/config.json`: YApi configuration file for customizing settings.
- `.gitignore`: Specifies files and directories to be ignored by Git.

## Installation and Usage

### Prerequisites

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

### Start the Service

1. Clone this repository:

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

2. Start the services:

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

3. Access YApi:

   Open your browser and navigate to `http://localhost:3000` to use YApi.

## Configuration

Modify the `yapi-conf/config.json` file as needed to adjust YApi settings, such as database connection details and port configurations.

## Contribution

Contributions and suggestions are welcome. Please submit a Pull Request or Issue to this project.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.