# Gozero共享mod微服务框架之v1.5.0

**Repository Path**: trident-framework/gozero-microservices

## Basic Information

- **Project Name**: Gozero共享mod微服务框架之v1.5.0
- **Description**: Gozero共享mod微服务框架【v1.5.0】
可运行golang版本【v1.18、v1.19、v1.20、v1.21、v1.22、1.23】
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-10-20
- **Last Updated**: 2025-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GoZero 微服务示例

这是一个基于 GoZero 框架构建的微服务项目示例，包含了常见的服务组件如公共服务（包含横幅和区域管理）和用户服务（包含用户信息和收货地址管理），以及一个网关 API 服务。

## 项目结构

该项目主要由三个部分组成：

- **common-service**: 提供公共 RPC 服务，包括横幅（Banner）和区域（Region）的增删改查功能。
- **user-service**: 提供用户相关的 RPC 服务，包括用户信息管理和收货地址管理。
- **gateway-api**: 提供 RESTful API 接口，作为前端应用与后端微服务之间的网关。

## 安装指南

### 公共服务 (common-service)

1. 确保你已经安装了 Go 和 GoZero 框架。
2. 进入 `common-service/rpc` 目录并运行服务：
   ```bash
   cd common-service/rpc
   go run common.go -f etc/common.yaml
   ```

### 用户服务 (user-service)

1. 进入 `user-service/rpc` 目录并运行服务：
   ```bash
   cd user-service/rpc
   go run user.go -f etc/user.yaml
   ```

### 网关服务 (gateway-api)

1. 进入 `gateway-api` 目录并运行服务：
   ```bash
   cd gateway-api
   go run main.go -f etc/app.yaml
   ```

## 使用说明

### 公共服务

#### 横幅服务 (Banner)

- **添加横幅**: `POST /banner/add`
- **删除横幅**: `POST /banner/delete`
- **编辑横幅**: `POST /banner/edit`
- **编辑状态**: `POST /banner/edit-status`
- **详情查询**: `GET /banner/detail?id=1`
- **列表查询**: `GET /banner/list`
- **总数查询**: `GET /banner/total`

#### 区域服务 (Region)

- **添加区域**: `POST /region/add`
- **详情查询**: `GET /region/detail?id=1`
- **列表查询**: `GET /region/list`

### 用户服务

#### 用户管理

- **注册用户**: `POST /user/register`
- **列表查询**: `GET /user/list`

## API 文档

完整的 API 文档可以通过访问网关服务提供的接口来获取。每个接口都支持相应的 HTTP 方法，并且需要传递必要的参数。

## 贡献指南

如果你有兴趣贡献代码或提出改进建议，请遵循以下步骤：

1. Fork 仓库。
2. 创建新的分支 (`git checkout -b feature/new-feature`)。
3. 提交你的更改 (`git commit -am 'Add some feature'`)。
4. 推送到分支 (`git push origin feature/new-feature`)。
5. 创建 Pull Request。

## 许可证

本项目采用 MIT 许可证。详情请参阅 LICENSE 文件。

## 联系方式

如果你有任何问题或建议，欢迎联系项目维护者。

---

这个 README 提供了一个高层次的概述，具体的功能实现和配置细节可以在各自的模块中找到。希望这份文档能够帮助你快速上手这个 GoZero 微服务项目。