Protocol BuffersでSwaggerを吐くことが出来ますが、その際にParametersの個々のfieldにdescriptionをどうやったら付けれるのかよく分からなかったのでメモ。
どういうこと?
これを追加したかった。
やり方
至極簡単で、OpenAPIのfieldを使ってゴニョゴニョすればいい。
例えば以下のような感じで、protocファイルに記述する。
message HogeRequest { uint64 id = 1 [(grpc.gateway.protoc_gen_swagger.options.openapiv2_field) = {description: "Test hoge"}]; }
簡単なことだけど、これに気付くまでにめちゃくちゃかかった・・・