🔗

【Go】application/x-www-form-urlencodedでリクエストしてみる

に公開

はじめに

現在携わっているプロジェクトで、Content-Typeがapplication/x-www-form-urlencodedであるAPIにリクエストを送るという実装を行いました。
今までContent-Typeがapplication/jsonのものを扱うことがほとんどだったので、実装する上で調べたことを備忘録的に書いていこうと思います。

この記事でわかること

  • application/x-www-form-urlencodedの概要
  • Goでapplication/x-www-form-urlencoded形式のリクエストを送る方法
  • Goでapplication/x-www-form-urlencoded形式のデータを受け取る方法

application/x-www-form-urlencodedとは?

application/x-www-form-urlencodedとは、Content-Typeの一種です。
Content-Typeとはヘッダーの一つで、リクエストやレスポンスの際のデータの種類を表すものです。text/plainならプレーンなテキストデータ、application/jsonならJSON形式のデータであることがわかります。

application/x-www-form-urlencodedには、以下のような特徴が見られます。

  • フォームから送られるデータをエンコードするためのContent-Type
  • リクエストデータがキーバリュー形式になっており、複数のデータがある場合は&で結合する
  • キーやバリューが英数字・一部記号以外の場合はパーセントエンコーディングされる

Goでapplication/x-www-form-urlencodedでリクエストしてみる

それでは実際に、Go(Echo)でどのようにapplication/x-www-form-urlencoded形式でリクエストができるのか見ていきましょう。
今回は、以下のようなデータを送ってみようと思います。

name=Tomoya&age=20

APIへのリクエスト

まずは、リクエストを送る部分の全体像を見ていきましょう。

send.go
package handler

import (
    "encoding/json"
    "io"
    "net/http"
    "net/url"
    "strconv"
    
    "github.com/labstack/echo/v4"
)

type Data struct {
    Name string `json:"name"`
    Age  string `json:"age"`
}

func Send(ctx echo.Context) error {
    name := "Tomoya"
    age := 20
    
    // リクエストデータをセット
    form := url.Values{}
    form.Set("name", name)
    form.Set("age", strconv.Itoa(age))
    
    // APIにリクエスト
    resp, err := http.Post("http://localhost:8080/external", "application/x-www-form-urlencoded", strings.NewReader(form.Encode()))
    if err != nil {
        return ctx.JSON(http.StatusInternalServerError, err)
    }
    defer resp.Body.Close()
    
    // APIからのレスポンスデータを読み込む
    body, err := io.ReadAll(resp.Body)
    if err != nil {
        return ctx.JSON(http.StatusInternalServerError, err)
    }
    
    // JSON形式に変換
    var data Data
    if err := json.Unmarshal(body, &data); err != nil {
        return ctx.JSON(http.StatusInternalServerError, err)
    }
    
    return ctx.JSON(http.StatusOK, data)
}

ここでは、以下のような順で処理が実行されています。

1. リクエストデータをセット

APIへリクエストを行うにあたり、リクエストデータをセットしています。

send.go
name := "Tomoya"
age := 20

// リクエストデータをセット
form := url.Values{}
form.Set("name", name)
form.Set("age", strconv.Itoa(age))

Goでは、urlパッケージのValuesというマップを初期化することで、キーバリューをセットすることができます。Valuesは以下のように定義されています。

url.go
type Values map[string][]string

string型のキーに対し、複数のstring型のバリューを持つことができるよう定義されています。
ですので、int型であるageはstring型に変換する必要があります。

ここに、Set()メソッドを使うことで、キーバリュー形式のリクエストデータをセットすることができます。

2. APIにリクエスト

リクエストを送信するためには、httpパッケージのPost()メソッドを使います。
Post()メソッドは以下のようなシグネチャとなっています。

client.go
func Post(url, contentType string, body io.Reader) (resp *Response, err error)
  • 第一引数:リクエスト先のURL
  • 第二引数:Content-Type(今回はx-www-form-urlencoded)
  • 第三引数:データ(io.Reader型にする必要あり)
    このようになっており、今回はリクエストデータを読み込めればいいので、stringsパッケージのNewReader()を使って変換しています。
    ※form.Encode()でx-www-form-urlencodedでのキーバリュー形式に変換

3. APIからのレスポンスデータを読み込む

レスポンスデータを読み込むために、ioパッケージのReadAll()メソッドを使いました。

4. JSON形式に変換

今回はJSON形式で最終的にレスポンスをしたいので、json.Unmarshal()メソッドを使いました。

APIの処理

次に、リクエストを受け取るAPI側の処理を見ていきます。

main.go
func External(ctx echo.Context) error {
    // キーに紐づく値を取得
    name := ctx.FormValue("name")
    age := ctx.FormValue("age")
    
    // 名前の文字列を逆順にする
    reverseName := []rune(name)
    slices.Reverse(reverseName)
    
    return ctx.JSON(http.StatusOK, echo.Map{
        "name": string(reverseName),
        "age":  age + "歳",
    })
}

このAPIではリクエストデータを受け取り、名前は文字列を逆順にし、年齢には「歳」を追加してレスポンスするようにしています。

ここで確認したいのは、リクエストデータの受け取り部分についてです。
Echoでフォーム形式の値を取得するためには、FormValue()メソッド使います。引数にキーを文字列で指定することで取得することができます。

リクエストしてみる

最後に、実際にリクエストしてみましょう。

ターミナル
# curl -X POST -H "Content-Type: application/x-www-form-urlencoded" http://localhost:8080/send

{"name":"ayomoT","age":"20歳"}

無事にリクエストをすることができました!

まとめ

今回はGoでapplication/x-www-form-urlencoded形式のリクエストについてみていきました。
application/jsonと比べると扱う機会は少ないものの、外部APIとの連携やレガシーなシステムとの通信ではまだまだ利用される形式です。
Goではurl.Valuesを使うことで直感的にフォームデータを組み立てられ、http.Post()やhttp.PostForm()を使って簡単に送信できることがわかりました。

受け取る側もEchoのFormValue()を使うだけなので、簡単に値を取得することができます。
送信も受信もシンプルなコードで完結できるのが、フォームエンコード形式の大きな利点と言えます。

参考

Discussion