# douyincloud-gin-demo

**Repository Path**: ByteDance/douyincloud-gin-demo

## Basic Information

- **Project Name**: douyincloud-gin-demo
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-26
- **Last Updated**: 2026-03-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# douyincloud-gin-demo
本项目是抖音云平台基于go语言gin框架的开发模版，模版通过使用Redis和MongoDB实现了简单的hello-world功能。\
抖音云平台支持基于Git代码和Docker镜像部署两种方式。其中，Dockerfile文件可以参考本项目中的Dockerfile文件。
部署在抖音云平台的服务日志需要重定向到标准输出，并在抖音云平台日志功能中查看。

## 目录结构
~~~
.
├── Dockerfile              Dockerfile文件
├── Readme.md               Readme文件
├── component               组件目录
│ ├── mongo.go              mongo组件
│ ├── redis.go              redis组件        
│ └── types.go              组件接口声明
├── go.mod                  go.mod文件
├── go.sum                  go.sum文件
├── main.go                 主函数入口
├── run.sh                  容器运行时启动文件
└── service                 业务逻辑目录
    └── service.go          业务逻辑文件
~~~

## 请求方法
前往抖音云托管平台「调试」功能界面，进行请求调试。

## API说明
### `GET /api/hello`
对组件打招呼

### 请求参数
- `target`：`string` 组件名：redis，mongodb

### 响应结果
```json
{
    "err_no": 0,
    "err_msg": "success",
    "data": "hello,redis"
}
```

### `POST /api/set_name`
给组件设置名称

### 请求参数
- `target`:`string` 组件名：redis，mongodb
- `name`:`string` 名称

### 响应结果
```json
{
    "err_no": 0,
    "err_msg": "success",
    "data": ""
}
```

### 组件使用注意事项
在抖音云托管平台上启用组件后，抖音云平台会自动将组件的地址，账号，密码以环境变量的方式注入到容器中。\
以Redis为例，在抖音云托管平台启用Redis组件后，平台会生成 `REDIS_ADDRESS`，`REDIS_USERNAME`，`REDIS_PASSWORD`三个环境变量，在业务代码中可以使用如下代码获取相应值。
```
	redisAddr := os.Getenv("REDIS_ADDRESS")
	redisUserName := os.Getenv("REDIS_USERNAME")
	redisPassword := os.Getenv("REDIS_PASSWORD")
```

## License

This project is licensed under the [Apache-2.0 License](LICENSE).