This is a plugin for the Google Protocol Buffers compiler protoc that generates code to implement json.Marshaler and json.Unmarshaler using jsonpb.
This enables Go-generated protobuf messages to be embedded directly within
other structs and encoded with the standard JSON library, since the standard
encoding/json
library can't encode certain protobuf messages such as
those that contain oneof
fields.
go get github.com/jonahgeorge/protoc-gen-gogo-json
Also required:
Define your messages like normal:
syntax = "proto3";
message Request {
oneof kind {
string name = 1;
int32 code = 2;
}
}
The example message purposely uses a oneof
since this won't work by
default with encoding/json
. Next, generate the code:
protoc --go_out=. --gogo-json_out=. request.proto
Your output should contain a file request.pb.json.go
which contains
the implementation of json.Marshal/Unmarshal
for all your message types.
You can then encode your messages using standard encoding/json
:
import "encoding/json"
// Marshal
bs, err := json.Marshal(&Request{
Kind: &Kind_Name{
Name: "alice",
},
}
// Unmarshal
var result Request
json.Unmarshal(bs, &result)