コンテンツにスキップ
Gin Web Framework

クイックスタート

Ginクイックスタートへようこそ！このガイドでは、Ginのインストール、プロジェクトのセットアップ、最初のAPIの実行までを順を追って説明します。自信を持ってWebサービスの構築を始められるようになります。

前提条件

  • Goバージョン: GinにはGoバージョン1.25以上が必要です
  • GoがPATHに含まれ、ターミナルから使用可能であることを確認してください。Goのインストールについては、公式ドキュメントをご覧ください。

ステップ1: Ginのインストールとプロジェクトの初期化

まず、新しいプロジェクトフォルダを作成し、Goモジュールを初期化します：

Terminal window
mkdir gin-quickstart && cd gin-quickstart
go mod init gin-quickstart

Ginを依存関係として追加します：

Terminal window
go get -u github.com/gin-gonic/gin

ステップ2: 最初のGinアプリの作成

main.goというファイルを作成します：

Terminal window
touch main.go

main.goを開き、以下のコードを追加します：

package main


import "github.com/gin-gonic/gin"


func main() {
  router := gin.Default()
  router.GET("/ping", func(c *gin.Context) {
    c.JSON(200, gin.H{
      "message": "pong",
    })
  })
  router.Run() // デフォルトで0.0.0.0:8080でリッスンします
}

ステップ3: APIサーバーの実行

以下のコマンドでサーバーを起動します：

Terminal window
go run main.go

ブラウザでhttp://localhost:8080/pingにアクセスすると、以下が表示されるはずです：

{"message":"pong"}

追加の例: net/httpとGinの併用

レスポンスコードにnet/httpの定数を使用したい場合は、それもインポートします：

package main


import (
  "github.com/gin-gonic/gin"
  "net/http"
)


func main() {
  router := gin.Default()
  router.GET("/ping", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
      "message": "pong",
    })
  })
  router.Run()
}

ヒントとリソース

  • Goが初めてですか？公式GoドキュメントでGoコードの書き方と実行方法を学びましょう。

  • Ginの概念を実践的に学びたいですか？インタラクティブなチャレンジやチュートリアルについては学習リソースをご覧ください。

  • フル機能の例が必要ですか？以下のコマンドでスキャフォールドしてみましょう：

    Terminal window
    curl https://raw.githubusercontent.com/gin-gonic/examples/master/basic/main.go > main.go

  • より詳細なドキュメントについては、Ginソースコードドキュメントをご覧ください。