背景
毎回、GoとGinによるAPIの環境構築の手順を忘れるので、ここに備忘録として残します。
環境
OS: macOS 13.6.4(22G513)
チップ:Apple M2 Pro
GOバージョン:go1.21.3
手順
1. GOのインストール
こちらのサイト(https://go.dev/doc/install) を参考にインストールしてください。
2. プロジェクト用のディレクトリを作成
以下のコマンドを使って任意の場所にプロジェクト用のディレクトリを作成して移動します。
.zsh
mkdir back
cd back
3. goをinitする
以下のコマンドを使って、GOのmodファイルを作成します。
{モジュール名}
は適当で良いです。
.zsh
go mod init {モジュール名}
すると、以下のように表示されます。
.zsh
go: creating new go.mod: module {モジュール名}
4. ginをインストールする
以下のコマンドを使って、ginに必要なものをインストールします。
.zsh
go get -u github.com/gin-gonic/gin
5. main.goファイルを作成する。
GOの基本ファイルとなる、main.go
ファイルを作成します。
.zsh
touch main.go
6. 最初のAPIを記述する。
以下の内容をmain.goファイルに記述します。
main.go
package main
import "github.com/gin-gonic/gin"
func main() {
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "pong",
})
})
r.Run() // 0.0.0.0:8080 でサーバーを立てます。
}
7. サーバを立ち上げる。
以下のコマンドを使って、サーバを立ち上げます。
.zsh
go run main.go
8. ブラウザからサーバにアクセスする。
ブラウザからlocalhost:8080/ping
にアクセスします。
ブラウザで以下のようにJSONが帰ってくれば、環境構築は完了です。
完了
お疲れ様でした。これで環境構築完了です。