Goの構造体をJSONに変換!

Goの構造体を入力すると、jsonタグどおりのサンプルJSONを作ります!Go (Golang) struct, json tags 対応。API ドキュメントやテスト用のリクエストボディ(sample JSON)に。
Go struct
結果
 

Goの構造体をJSONに変換!

Go の struct 定義を貼り付けると、encoding/json がマーシャリング時に適用するのと同じルールで例の JSON ドキュメントを作ります。json:"..." タグの名前、- で隠したフィールド、,string オプション、エクスポートされない小文字のフィールド、フラット化される埋め込み構造体に対応しています。

Gin、Echo、net/http のリクエスト構造体から curl のボディを作るとき、gRPC-Gateway や REST ドキュメントのサンプルを用意するとき、タグが期待どおりのキーを生まないフィールドを見つけるときに便利です。

使い方

  1. type Xxx struct { ... } の宣言を貼り付けます。type ( ... ) でまとめたブロックや、複数の構造体を一度に貼っても構いません。
  2. フィールドが別の構造体を使っている場合は、その定義も含めてください。入力にない外部パッケージの型(decimal.Decimal など)は null になります。
  3. オプションはありません。他の型から参照されていない最初の構造体がトップレベルの JSON になるので、目的の構造体を先頭に置くか、関係のない構造体を外してください。
  4. 結果をコピーして、curl -d、Postman のボディ、httptest を使ったハンドラーテストに使います。

例

入力 (Go struct)
type Base struct {
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at"`
}

type Job struct {
	Base
	Queue      string            `json:"queue"`
	Attempts   int               `json:"attempts,string"`
	Labels     map[string]string `json:"labels,omitempty"`
	TimeoutSec *int              `json:"timeout_sec,omitempty"`
	Token      string            `json:"-"`
	Done       bool
	lastErr    error
}
出力 (JSON)
{
  "id": "",
  "created_at": "0001-01-01T00:00:00Z",
  "queue": "",
  "attempts": "0",
  "labels": {
    "key": ""
  },
  "timeout_sec": 0,
  "Done": false
}

埋め込みの Base は id と created_at を Job に直接追加し、,string タグの付いた Attempts は数値ではなく文字列 "0" になります。Token(タグ -)とエクスポートされない lastErr は除外され、タグのない Done は Go のフィールド名をそのままキーにしています。time.Time には Go のゼロ値 0001-01-01T00:00:00Z が入っています。

対応機能

  • json:"name" タグをキーとして使い、タグがなければフィールド名をそのまま使います。
  • json:"-" のフィールドとエクスポートされない小文字のフィールドは除外します。json:"-," は文字どおり - というキーでフィールドを残します。
  • ,string があると、数値や真偽値のフィールドは "0"、"false" のように文字列で包まれます。
  • タグのない埋め込み構造体は親にフラット化され、名前が衝突した場合は外側のフィールドが優先されます。タグ付きの埋め込み構造体は、その名前のネストしたオブジェクトになります。
  • ポインター(*int、*Profile)は指す先の型で埋め、type Status string のような定義型は基底型に従います。
  • []byte は Base64 の(空の)文字列、map[int]T は "0" をキーにし、time.Duration はナノ秒の整数 0、interface{}/any は null になります。
  • Children []Node のような自己参照構造体は空の配列で止まります。匿名のネストした構造体フィールドにも対応しています。

利用シーン

ハンドラーテスト用のリクエストボディ

c.ShouldBindJSON(&req) でバインドする構造体を貼り付けてボディを生成し、httptest.NewRequest や curl でエンドポイントを呼び出せます。キーはタグから直接作られるので、バインドの食い違いが起きにくくなります。

タグの間違いを見つける

json:"user_id" と json:"userId" のタグが混在していたり、タグを付け忘れて大文字の UserID キーが漏れていたりすると、出力を見ればひと目でわかります。

他言語のクライアントとスキーマを共有する

Go のレスポンス構造体から作った JSON をフロントエンドや Python の利用者に渡せば、JSON → TypeScript や JSON → Python などのツールでモデルに戻してもらえます。

注意点と制限

  • omitempty のフィールドもサンプルには常に表示されます。実際のマーシャリングでは、ゼロ値のときに省かれます。
  • nil のポインターは null としてマーシャリングされますが、サンプルには値が入った場合を表示します。
  • 独自の MarshalJSON() を持つ型や、json.RawMessage の実際の中身は知りようがないため反映されません。
  • Go 1.24 の omitzero のような新しいオプションや、encoding/json/v2 の挙動には対応していません。

よくある質問

タグのないフィールドのキーはどうなりますか?

encoding/json はエクスポートされたフィールド名をそのまま使うので、Done bool は "Done" になります。Go でのデコードは大文字・小文字を区別せずに照合しますが、他の言語のクライアントは区別するので、タグを明示しておくほうが安全です。

time.Time が 0001 年になっているのはなぜですか?

Go の time.Time のゼロ値は 0001-01-01 00:00:00 UTC で、RFC 3339 では 0001-01-01T00:00:00Z としてマーシャリングされます。そのため、他の → JSON ページの 1970 年の日付とは異なります。

json:",string" はどんなときに役立ちますか?

主に、JavaScript では正確に表現できない大きな int64 の ID を文字列として送るためです。サンプルには "0" と表示されるので、クライアントにも文字列で届くことがはっきり伝わります。

逆に、JSON から Go の構造体を作りたいです。

JSON → Go struct のページを使ってください。その出力をこのページに戻せば、往復しても元のキーが保たれるかを手早く確認できます。