【Golang】Ginを活用したAPIの実装方法をサンプルコード付きで解説

// グローバル変数定義
var DB *sqlx.DB

• DB はグローバル変数として宣言
• *sqlx.DB はポインタ型のデータベース接続オブジェクト

	// .envファイルの読み込み
	err := godotenv.Load()
	if err != nil {
		log.Fatal(".envファイルの読みこみに失敗しました。", err)
	}

• .env ファイルを読み込み、環境変数をプログラム内で利用できるようにします。
• .env が存在しない場合や読み込みに失敗した場合、err が発生します。
• .env の読み込みに失敗した場合、プログラムを強制終了 (log.Fatal) します。

	// DSN作成
	dsn := fmt.Sprintf(
		"user=%s password=%s host=%s port=%s dbname=%s sslmode=%s",
		os.Getenv("DB_USER"),
		os.Getenv("DB_PASSWORD"),
		os.Getenv("DB_HOST"),
		os.Getenv("DB_PORT"),
		os.Getenv("DB_NAME"),
		os.Getenv("DB_SSLMODE"),
	)

• os.Getenv("DB_USER") などで .env に定義された環境変数を取得します。
• fmt.Sprintf を使って、データベースの接続文字列 (DSN) を作成します。

	// DB接続
	db, err = sqlx.Connect("postgres", dsn)
	if err != nil {
		log.Fatal("DB接続に失敗しました。", err)
	}

• sqlx.Connect("postgres", dsn) を使って PostgreSQL に接続します。
• DB というグローバル変数に接続オブジェクトを代入します。
• データベースへの接続に失敗した場合、エラーメッセージを表示してプログラムを強制終了 (log.Fatal) します。

// User モデル
type User struct {
	UserID   string `json:"user_id" db:"user_id"`
	UserName string `json:"user_name" db:"user_name"`
}

• この構造体は、データベースの test_table テーブルと対応するデータモデルで、APIでユーザー情報をやり取りする際に使用します。
• タグ json:"user_id"
  • JSON 形式でデータを送受信するとき、フィールド名を "user_id" に変換します。
• タグ db:"user_id"
  • データベースと連携する際、このフィールドが user_id カラム にマッピングされます。

// ユーザー一覧取得
func GetUsers(c *gin.Context) {...}

• CetUsers は Gin フレームワーク の Context を受け取る関数です。
• c *gin.Context を通じて、HTTPリクエストのデータ取得やレスポンスの返却 を行います。

	var users []models.User
	err := config.DB.Select(&users, "SELECT * FROM test_table")
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}
    c.JSON(http.StatusOK, users)

• var users []models.User
  • users は ユーザー情報の一覧を保持するための変数です。
• err := config.DB.Select(&users, "SELECT * FROM test_table")
  • PostgreSQL から test_table 内のすべてのレコードを取得 し、結果を users スライスに格納します。
• if err != nil { … }
  • もし err にエラーが格納されていた場合、データ取得に失敗しているため、クライアントに 500 Internal Server Error を返します。
  • その後 return により処理を中断し、以降のコードが実行されないようにしています。
• c.JSON(http.StatusOK, users)
  • エラーがなければ、取得した users スライスを JSON 形式でクライアントに返します。
  • HTTP ステータスコード 「200 OK」 を設定し、JSON データをレスポンスとして送信します。

// ユーザー登録
func CreateUser(c *gin.Context) {...}

• CreateUser は Gin フレームワーク の Context を受け取る関数です。
• c *gin.Context を通じて、HTTPリクエストのデータ取得やレスポンスの返却 を行います。

	var user models.User
	if err := c.ShouldBindJSON(&user); err != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

• var user models.User
  • user に、クライアントから送られてきた JSON データをバインドしていきます。
• if err := c.ShouldBindJSON(&user); err != nil { … }
  • c.ShouldBindJSON(&user) は Gin フレームワークのメソッド で、HTTP リクエストの ボディに含まれる JSON データを user 構造体にバインド します。
• バインドが成功すると、user 変数にクライアントから送られてきた JSON のデータが格納されます。もしバインドに失敗した場合、エラー内容が err に設定されます。

	_, err := config.DB.Exec("INSERT INTO test_table (user_id, user_name) VALUES ($1, $2)", user.UserID, user.UserName)
	if err != nil {
		c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
		return
	}

• _, err := config.DB.Exec("INSERT INTO test_table (user_id, user_name) VALUES ($1, $2)", user.UserID, user.UserName)
  • config.DB.Exec は、Exec メソッドを使ってSQL クエリを実行するためのコードです。
  • このクエリでは、test_table というテーブルに user_id と user_name の2つのカラムに対してデータを挿入します。
• if err != nil { … }
  • err が nil でない場合、つまり SQL クエリ実行中にエラーが発生した場合 に次の処理が実行されます。
  • err != nil の条件式が エラーが発生したことを示します。
• c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
  • c.JSON は、HTTP レスポンスをクライアントに返すためのメソッドです。
  • http.StatusInternalServerError は HTTP ステータスコード 500を意味し、サーバー内でエラーが発生したことを示します。
  • gin.H{"error": err.Error()} は、エラーメッセージを JSON 形式でレスポンスとして返すためのコードです。

c.JSON(http.StatusCreated, gin.H{"message": "User created"})

• c.JSON は、Gin フレームワークのメソッドで、HTTP レスポンスを JSON 形式で返すために使用します。
  • 第一引数：HTTP ステータスコードを指定します。
    • http.StatusCreated は定数で、HTTP ステータスコード 201 を意味します。
  • 第二引数：JSON 形式のレスポンスボディを指定します。
• gin.H{"message": "User created"}
  • gin.H は Gin のヘルパーで、簡易的にマップ（key-value ペア）を作成するために使います。この場合、以下のように JSON オブジェクトを作成しています。
    • "message" は JSON オブジェクトのキー。
    • "User created" はそのキーに対応する値で、ユーザーが正常に作成されたことを伝えるメッセージです。

// ユーザー関連のルート
func SetupRouter() *gin.Engine {
	r := gin.Default()

	r.GET("/users", handlers.GetUsers)
	r.POST("/users", handlers.CreateUser)

	return r

• r *gin.Engine は Gin フレームワークのエンジンオブジェクト（ルータ）を引数として受け取ります。
• r.GET は、HTTP GET リクエストに対応するルートを定義します。
• r.POST は、HTTP POST リクエストに対応するルートを定義します。

	config.InitDB()

• アプリケーションの動作に必要なデータベース接続を確立するために、プログラム開始時にデータベース接続を初期化します。
• config パッケージ内の InitDB 関数を呼び出して、データベースの接続を初期化しています。

defer config.DB.Close()

• defer キーワードを使って、main 関数が終了する際に config.DB.Close() が呼ばれるようにしています。
• これにより、データベースの接続を適切に終了することができます。

r := routes.SetupRouter()

• routes パッケージ内の SetupRouter 関数を呼び出して、HTTPリクエストに対するルーティングを設定した r を取得します。
• この関数では、アプリケーションが処理するURLパスと対応するハンドラ関数を定義しています

log.Fatal(r.Run(":8080"))

• r.Run(":8080") でWebサーバーをポート8080で開始します。
• もしサーバーの起動に失敗した場合、log.Fatal が呼ばれ、そのエラーメッセージがログに記録され、プログラムが終了します。

curl -X POST "http://localhost:8080/users" -H "Content-Type: application/json" -d "{\"user_id\": \"123\", \"user_name\": \"tamura\"}"

　⇒{"message":"User created successfully"}が出力されたら成功です。

curl -X GET "http://localhost:8080/users"

　⇒[{"user_id":"123 ","user_name":"tamura "}]が出力されたら成功です。