アプリケーションの構成
Gin は Gin入門 で学んだ通り、ハンドラの書き方をシンプルにし、リクエストの取り出しやレスポンス書き込みを直感的に書けるようにするWebフレームワークです。
1. 使用するライブラリ
Gin は Gin入門 で学んだ通り、ハンドラの書き方をシンプルにし、リクエストの取り出しやレスポンス書き込みを直感的に書けるようにするWebフレームワークです。GORM は GORM入門 で学んだ通り、モデルベースのCRUDをコンパクトに書けるORMです。本章では、Gin と GORM を組み合わせてノートアプリケーションのREST APIを実装します。
2. 実装するCRUD操作
ノートに対して以下の5つのCRUD操作を扱います。この Create / Index / Show / Update / Delete という構成は、単一リソース(ここでは「ノート」)を扱うREST APIで一般的に用いられるパターンで、Ruby on Rails・Laravel・FastAPI など多くのWebフレームワークでも同じ組み合わせが採用されています。本章では、Create → Index → Show → Update → Delete の順で1節ずつ実装していきます。
| 操作 | メソッド | パス | 内容 |
|---|---|---|---|
| Create | POST | /notes |
ノートを新規作成する |
| Index | GET | /notes |
ノートの一覧を取得する |
| Show | GET | /notes/{id} |
指定IDのノートを1件取得する |
| Update | PUT | /notes/{id} |
指定IDのノートを更新する |
| Delete | DELETE | /notes/{id} |
指定IDのノートを削除する |
3. ファイル構成
CRUDを実装するにあたって、以下の3ファイル構成で進めます。各ファイルは同じパッケージ(package main)に属し、役割ごとに分けます。
notes-gin/
├── main.go ← エントリポイント(DB接続・ルーティング・サーバ起動)
├── handler.go ← 各エンドポイントのハンドラ関数
└── model.go ← Noteモデル(DBテーブルとGoの構造体の対応付け)
各ファイルの役割は以下のとおりです。
| ファイル | 役割 |
|---|---|
model.go |
データベーステーブルと対応するGoの構造体(Note)を定義する |
handler.go |
各HTTPエンドポイントの処理を担うハンドラ関数を定義する |
main.go |
データベース接続、ルーティング登録、サーバ起動などのエントリポイント処理を担う |
以降は、プロジェクトの準備 → モデル定義 → main.go の初期実装 → 各CRUDハンドラ(作成 → 一覧取得 → 単一取得 → 更新 → 削除)の順で、少しずつファイルに追記しながら進めます。