grpc-ecosystem/grpc-gateway

protoc-gen-swagger doesn't output to specified --swagger_out directory

オープン

#383 opened on 2017/05/11

GitHub で見るコントリビューターガイド
 (7 件のコメント) (1 件のリアクション) (0 人の担当者)Go (2,250 件のフォーク)batch import
bughelp wantedopenapi

Repository metrics

Stars
 (16,971 個のスター)
PR merge metrics
 (平均マージ 8d 23h) (30d で 147 merged PRs)

説明

Invoking protoc-gen-swagger with:

protoc -I/usr/local/include -I. -I$GOPATH/src \
  -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
  --swagger_out=logtostderr=true:. \
  mycorp/api/user/v1/user_service.proto

The outputted file ends up in mycorp/api/user/v1/, not the current working directory.

コントリビューターガイド

調査方針
問題は、protoc gen swagger がファイルを proto ファイルと同じディレクトリに出力し、 swagger out で指定されたディレクトリに出力しないことです。修正するには、ジェネレーターコードの出力パスロジックを調査してください。おそらく 'protoc gen swagger/main.go' または 'generator.go' にあります。proto ファイルパスと swagger out ディレクトリから出力ファイルパスがどのように構築されるかを確認します。修正では、生成されたファイルのベースディレクトリが出力ディレクトリであることを保証する必要があります。
技術スタック
go
領域
backendapi
Issue 種別
バグ
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
GoProtocol Buffers
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70