Go言語でREST APIを作る設計と実装パターン完全ガイド！初心者でもわかるAPI開発

1. Go言語とREST APIとは？

1. Go言語とREST APIとは？

Go言語は、シンプルで速く動くプログラミング言語です。Googleが開発しており、WebサービスやAPI開発で多く使われています。REST APIとは、インターネット上でデータをやり取りするための決まりごとです。難しく感じるかもしれませんが、「注文すると料理が運ばれてくるレストラン」のような仕組みだと考えると分かりやすいです。注文内容がリクエスト、料理がレスポンスにあたります。

2. REST APIの基本構造を理解しよう

2. REST APIの基本構造を理解しよう

REST APIでは、「URL」「HTTPメソッド」「データ形式」が重要です。URLは住所、HTTPメソッドは動作の種類です。たとえばGETは「取得」、POSTは「追加」を意味します。Go言語では、これらを標準ライブラリだけで扱えます。特別な道具を用意しなくても、最初からAPI開発ができる点が大きな特徴です。

3. 最小構成のREST APIを作ってみよう

3. 最小構成のREST APIを作ってみよう

まずは、最もシンプルなREST APIを作ります。これは「アクセスすると文字を返すだけ」のAPIです。動作の流れを理解することが目的なので、内容はとても簡単です。

package main

import (
    "fmt"
    "net/http"
)

func handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintln(w, "Hello API")
}

func main() {
    http.HandleFunc("/", handler)
    http.ListenAndServe(":8080", nil)
}

このコードでは、8080番ポートでサーバーを起動しています。ブラウザからアクセスすると文字が表示されます。これがGo言語で作るREST APIの第一歩です。

4. JSON形式でデータを返す設計

4. JSON形式でデータを返す設計

REST APIでは、JSONという形式でデータを返すことが一般的です。JSONは「名前と値のセット」で表現され、人にも機械にも読みやすい形式です。Go言語では構造体を使ってJSONを簡単に扱えます。

package main

import (
    "encoding/json"
    "net/http"
)

type Message struct {
    Text string `json:"text"`
}

func handler(w http.ResponseWriter, r *http.Request) {
    msg := Message{Text: "Hello JSON"}
    json.NewEncoder(w).Encode(msg)
}

func main() {
    http.HandleFunc("/message", handler)
    http.ListenAndServe(":8080", nil)
}

このように設計すると、アプリや他のサービスがデータを受け取りやすくなります。REST API設計では、データ形式をそろえることがとても重要です。

5. HTTPメソッドで処理を分ける考え方

5. HTTPメソッドで処理を分ける考え方

REST APIでは、同じURLでもHTTPメソッドによって動作を変えます。これは「同じドアでも、押すか引くかで動きが違う」ようなイメージです。Go言語ではリクエスト情報を確認して処理を分けます。

func handler(w http.ResponseWriter, r *http.Request) {
    if r.Method == http.MethodGet {
        w.Write([]byte("GET request"))
    } else if r.Method == http.MethodPost {
        w.Write([]byte("POST request"))
    }
}

この設計により、APIの役割が明確になり、保守しやすい構成になります。

6. ルーティング設計の基本パターン

6. ルーティング設計の基本パターン

ルーティングとは、URLごとに処理を分ける設計です。REST APIでは、意味のあるURLを作ることが重要です。たとえば「/users」や「/products」のように、扱うデータが分かる名前を使います。

http.HandleFunc("/users", usersHandler)
http.HandleFunc("/products", productsHandler)

このような設計にすると、APIの構造が直感的になり、初めて見た人でも理解しやすくなります。

7. エラーハンドリングの考え方

7. エラーハンドリングの考え方

API開発では、失敗したときの対応も大切です。エラーは「うまくいかなかった理由を伝えるメッセージ」です。Go言語では、ステータスコードを使って状況を伝えます。404は「見つからない」、500は「内部エラー」を意味します。

8. シンプルで分かりやすい設計を心がける

8. シンプルで分かりやすい設計を心がける

初心者向けのREST API設計では、機能を詰め込みすぎないことが大切です。Go言語の強みは、少ないコードで分かりやすく書ける点です。役割ごとに処理を分け、URLと動作が自然に結びつく設計を意識しましょう。これが長く使えるAPIにつながります。