# boundless_static_business_yapi

**Repository Path**: ShoneSingLone/boundless_static_business_yapi

## Basic Information

- **Project Name**: boundless_static_business_yapi
- **Description**: [boundless_vue](https://gitee.com/dashboard/projects?name=boundless_static&page=1)项目的业务项目——YAPI（vue魔改版）前端代码库

- 自定义功能
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-28
- **Last Updated**: 2026-01-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Boundless Static Business Yapi

这是一个基于 YAPI 的开源项目，旨在提供一个强大且灵活的接口管理平台。该项目结合了现代 Web 技术，提供了丰富的功能，包括接口文档管理、测试、Mock 服务等。

## 功能特性

- **接口管理**：支持接口的创建、编辑、删除和分类管理。
- **文档生成**：自动生成接口文档，支持 Markdown 和 HTML 格式。
- **测试功能**：提供接口测试工具，支持多种请求方法和参数类型。
- **Mock 服务**：支持生成 Mock 数据，方便前端开发和测试。
- **多语言支持**：支持多种语言的界面切换。
- **权限管理**：支持用户权限管理，确保数据安全。
- **集成工具**：集成了 CI/CD 工具，支持自动化部署和构建。

## 安装指南

### 环境要求

- Node.js (v14.x 或更高版本)
- npm 或 yarn
- MongoDB (用于数据存储)

### 安装步骤

1. **克隆仓库**：

    ```bash
    git clone https://gitee.com/ShoneSingLone/boundless_static_business_yapi.git
    cd boundless_static_business_yapi
    ```

2. **安装依赖**：

    ```bash
    npm install
    # 或者使用 yarn
    yarn install
    ```

3. **配置数据库**：确保 MongoDB 已安装并运行，然后在项目根目录下创建 `.env` 文件，配置数据库连接：

    ```env
    MONGO_URI=mongodb://localhost:27017/yapi
    ```

4. **启动项目**：

    ```bash
    npm run dev
    # 或者使用 yarn
    yarn dev
    ```

5. **访问项目**：打开浏览器，访问 `http://localhost:3000`，即可看到 YAPI 的界面。

## 使用说明

### 接口管理

- **创建接口**：在项目页面中，点击“新建接口”按钮，填写接口的基本信息、请求参数、响应示例等。
- **编辑接口**：点击接口名称，进入接口详情页面，可以编辑接口的各个部分。
- **删除接口**：在接口详情页面，点击“删除”按钮即可删除接口。

### 文档生成

- **导出文档**：在接口详情页面，点击“导出”按钮，可以选择导出为 Markdown 或 HTML 格式。
- **在线查看**：在项目页面中，点击“文档”按钮，可以在线查看生成的接口文档。

### 测试功能

- **接口测试**：在接口详情页面，点击“测试”按钮，可以发送请求并查看响应结果。
- **Mock 服务**：在接口详情页面，点击“Mock”按钮，可以生成 Mock 数据并进行测试。

### 多语言支持

- **切换语言**：在项目页面的右上角，点击语言切换按钮，可以选择不同的语言界面。

### 权限管理

- **用户管理**：在项目设置中，可以管理用户权限，分配不同的角色和权限。

### 集成工具

- **CI/CD 集成**：在项目设置中，可以配置 CI/CD 工具，支持自动化部署和构建。

## 贡献指南

欢迎贡献代码和文档！请遵循以下步骤：

1. **Fork 仓库**：在 Gitee 上 Fork 本仓库。
2. **创建分支**：创建一个新的分支进行开发。
3. **提交代码**：提交代码并编写清晰的提交信息。
4. **发起 Pull Request**：在 Gitee 上发起 Pull Request，等待审核和合并。

## 许可证

本项目使用 MIT 许可证。详情请参阅 [LICENSE](LICENSE) 文件。

## 联系我们

如有任何问题或建议，请在 Gitee 上提交 Issue 或联系项目维护者。