Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tf63/go-api
[勉強会資料] GoでAPIを作ってみる
https://github.com/tf63/go-api
Last synced: 24 days ago
JSON representation
[勉強会資料] GoでAPIを作ってみる
- Host: GitHub
- URL: https://github.com/tf63/go-api
- Owner: tf63
- Created: 2023-08-02T13:42:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-16T23:00:13.000Z (about 1 year ago)
- Last Synced: 2024-10-14T03:28:46.675Z (24 days ago)
- Language: Go
- Homepage:
- Size: 463 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## GOでREST, gRPC, GraphQLのAPIを設計する
[](https://github.com/tf63/go_api/actions/workflows/go.yml)
**概要**
家計簿を管理するAPIを作ってみる
- `Expense` : 支払いを管理する (title, price, user_idなどを持つ)
- `User` : ユーザーを管理 (nameなどを持つ)
**Todo**
- [x] OpenAPIでスキーマを作成する https://github.com/tf63/go_api/issues/1
- [x] Repositoryを作成する https://github.com/tf63/go_api/issues/4 https://github.com/tf63/go_api/issues/5
- [x] Entityを作成する https://github.com/tf63/go_api/issues/3
- [x] RESTサーバーを実装する https://github.com/tf63/go_api/issues/2
- [x] RESTサーバーをテストする https://github.com/tf63/go_api/issues/9 https://github.com/tf63/go_api/issues/13
- [x] gqlgenでスキーマを作成する https://github.com/tf63/go_api/issues/11
- [x] GraphQLサーバーを実装する https://github.com/tf63/go_api/issues/10
- [ ] GraphQLサーバーをテストする https://github.com/tf63/go_api/issues/12
- [ ] gRPCサーバーを実装する
- [ ] gRPCサーバーをテストする
- [ ] Add delight to the experience when all tasks are complete :tada:
**動作確認**
- REST https://github.com/tf63/go_api/issues/2
- GraphQL https://github.com/tf63/go_api/issues/10
**技術選定**
| 技術 | 役割 |
| - | - |
| net/http | サーバー (標準ライブラリ) |
| GORM | ORM |
| OpenAPI | REST用ライブラリ |
| oapi-codegen | OpenAPIのコード生成 |
| gqlgen | GraphQLライブラリ |
| testify | Goのテストライブラリ |
| godoc | ドキュメント生成 |
| Postman | APIの動作確認 |
| PostgreSQL | DB |
| pgAdmin | DBの監視 |
| Docker | 開発環境 |
| Github Actions | CI |
### 設計など
**API設計**
```mermaid
---
title: API (ver1)
---
%%{init:{'theme':'forest'}}%%
graph TB
External --> |:8080|RESTHandler
External --> |:9090|GraphQLHandler
RESTHandler --> ExpenseRepository
RESTHandler --> UserRepository
GraphQLHandler --> ExpenseRepository
GraphQLHandler --> UserRepository
ExpenseRepository --> ExpenseEntity
UserRepository --> UserEntity
ExpenseRepository --> PostgreSQL
UserRepository --> PostgreSQL
```
**テーブル設計**
```mermaid
---
title: DB (ver1)
---
%%{init:{'theme':'forest'}}%%
erDiagram
users ||--o{ expenses: ""
users {
bigint id "PK (index)"
string name "ユーザー名, not null"
timestamp created_at
timestamp updated_at
timestamp deleted_at
}
expenses {
bigint id "PK (index)"
bigint user_id "FK index"
string title "not null"
bigint price "default:0"
timestamp created_at
timestamp updated_at
timestamp deleted_at
}
```