生涯未熟

生涯未熟

プログラミングをちょこちょこと。

Protocol Buffersが出力するSwaggerのParameter descriptionを記述する方法

Protocol BuffersでSwaggerを吐くことが出来ますが、その際にParametersの個々のfieldにdescriptionをどうやったら付けれるのかよく分からなかったのでメモ。

どういうこと?

f:id:syossan:20190311192111p:plain

これを追加したかった。

やり方

至極簡単で、OpenAPIのfieldを使ってゴニョゴニョすればいい。

例えば以下のような感じで、protocファイルに記述する。

message HogeRequest {
  uint64 id = 1 [(grpc.gateway.protoc_gen_swagger.options.openapiv2_field) = {description: "Test hoge"}];
}

簡単なことだけど、これに気付くまでにめちゃくちゃかかった・・・