# MCoreAPI

**Repository Path**: chongshi-network/mcore-api

## Basic Information

- **Project Name**: MCoreAPI
- **Description**: No description available
- **Primary Language**: C#
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-01
- **Last Updated**: 2025-04-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MCoreAPI

#### 介绍
MCoreAPI 是一个游戏相关的 API 服务器解决方案，主要用于构建游戏相关的 API 服务。项目支持不同环境下的部署和运行，包含多个相关项目，涵盖了数据库操作、随机算法、认证授权等多个功能模块，同时支持多语言。

#### 软件架构
- **APIServer**：核心服务目录，包含了项目的主要代码和配置文件。
  - **GameAPI**：游戏 API 相关的代码，包含控制器、服务、模型等文件。
  - **Common**：公共代码目录，包含了通用的服务、模型、工具类等。
- **数据库**：目前仅支持远程 MongoDB，可通过 `GameAPI` 下的不同环境配置文件 `appsettings.xxx.json` 进行数据库连接字符串的配置。
- **容器化部署**：支持 Docker 容器化部署，通过 `docker-compose` 进行容器的构建和管理，可将 API 服务器的 Docker 容器部署到 Digital Ocean 云平台。

#### 安装教程
1. **克隆仓库**：使用 `git clone` 命令将项目克隆到本地。
```bash
git clone [项目仓库地址]
```
2. **配置数据库**：编辑 `GameAPI` 下的 `appsettings.xxx.json` 文件，将 `Database` 节点下的 `ConnectionString` 配置为你的 MongoDB 连接字符串。
```json
{
  "Database": {
    "ConnectionString": "your_mongodb_connection_string",
    "DatabaseName": "APIServerDev",
    "DefaultSuperAdminUsername": "SAdmin",
    "DefaultSuperAdminPassword": "12qw#$ER"
  }
}
```
3. **构建和运行项目**：可以使用 `.NET` 命令进行项目的构建和运行，也可以使用 Docker 进行容器化部署。
    - **使用 `.NET` 命令**：
```bash
cd mcore-api/APIServer/GameAPI
dotnet build
dotnet run
```
    - **使用 Docker 部署**：
```bash
cd mcore-api/APIServer
docker-compose -f docker-compose-game.yml -f docker-compose-game.dev.override.yml build
docker-compose -f docker-compose-game.yml -f docker-compose-game.dev.override.yml up -d
```

#### 使用说明
1. **API 文档**：项目集成了 Swagger，可以通过浏览器访问 `http://localhost:5172/swagger` 查看和测试 API 接口。
2. **认证和授权**：部分 API 接口需要进行认证和授权，可在 Swagger 中输入 JWT 令牌进行测试。
3. **数据库操作**：项目使用 MongoDB 作为数据库，通过 `DbRepo` 和 `DBService` 进行数据库操作。
4. **随机算法**：项目提供了动态加权随机选择器 `DynamicWeightedRandomizer` 和随机姓名生成器 `RandomName`，可用于实现随机选择和随机姓名生成功能。

#### 参与贡献
1. Fork 本仓库到自己的账户下。
2. 新建 Feat_xxx 分支进行代码开发。
```bash
git checkout -b Feat_xxx
```
3. 提交代码并推送到自己的仓库。
```bash
git add .
git commit -m "Your commit message"
git push origin Feat_xxx
```
4. 在原仓库中新建 Pull Request，等待审核和合并。

#### 特技
1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md。
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)。
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目。
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目。
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)。
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)。
```

以上内容仅供参考，你可以根据项目的实际情况进行调整和完善。