Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chalmeal/go-gin-file
Go(Gin)とAWS(S3)を想定し、MinIOを利用したファイルアップロード
https://github.com/chalmeal/go-gin-file
docker gin go-api go-example go-rest-api golang minio rest-api
Last synced: 1 day ago
JSON representation
Go(Gin)とAWS(S3)を想定し、MinIOを利用したファイルアップロード
- Host: GitHub
- URL: https://github.com/chalmeal/go-gin-file
- Owner: chalmeal
- Created: 2024-05-09T05:24:50.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-05-11T23:45:23.000Z (8 months ago)
- Last Synced: 2024-11-06T07:04:28.319Z (about 2 months ago)
- Topics: docker, gin, go-api, go-example, go-rest-api, golang, minio, rest-api
- Language: Go
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**go-gin-file**
Golang + Gin + MiniO
## はじめに
S3を想定したファイルダウンロード/アップロード実装です。MiniOを利用し、ローカル環境上でのストレージ利用を可能とします。
## 構成
```
├── main.go
├── docker-compose.yml
├── common
| ├── aws.go
| ├── db.go
| ├── response.go
| └── utils.go
├── config
| ├── app.ini
| └── config.go
├── app
| ├── models
| | ├── files.go
| | └── users.go
| └── api
| ├── controllers.go
| ├── file_controllers.go
| └── user_controllers.go
└── routes
└── api.go
```
## ドキュメント
### データ定義
| テーブル名 | 概要 |
| ------------------------------------------------------------------------------- | ---------------------------------------------------- |
| [files](https://github.com/chalmeal/go-gin-file/blob/master/.doc/data/files.md) | ファイルテーブル。アップロードされたファイルの情報。 |
| [users](https://github.com/chalmeal/go-gin-file/blob/master/.doc/data/users.md) | ユーザーテーブル。サービスの利用者情報。 |
### 仕様
| 書名 | 概要 |
| ----------------------------------------------------------------------------------------------- | ----------------------------------------- |
| [ファイル利用](https://github.com/chalmeal/go-gin-file/blob/master/.doc/method/ファイル利用.md) | ファイルアップロード/ダウンロードについて |
## セットアップ
### DB
* DBの環境は以下を想定します。
* MySQL
* GORM
* create schemaのみ行う必要があります。[DDL](.db/setup/ddl-create-schema.sql)
* [app.ini](config/app.ini)に対してDB接続情報を定義してください。
* テーブルはGORMが提供するAutoMigrateを利用します。
* 各テーブルは初回API実行時に生成されます。
* 本プロジェクトで定義されている詳細なデータ定義に関しては、各ドメインのdocを参照してください。
* ファイル：[files](https://github.com/chalmeal/go-gin-file/blob/master/.doc/data/files.md)
* ユーザー：[users](https://github.com/chalmeal/go-gin-file/blob/master/.doc/data/users.md)
### Docker
MinIOの利用にDockerを利用しています。Dockerの導入を行ってください。
## アプリケーションスタート
アプリケーションのスタートはデバッガを推奨しています。
Run and Debugの`Run go-echo-file`から実行してください。