grpc-ecosystem/grpc-gateway

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

Open

#383 opened on May 11, 2017

View on GitHub
 (7 comments) (1 reaction) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
bughelp wantedopenapi

Description

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.

Contributor guide

Tech stack
gogrpc
Domain
toolingdocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingprotoc usagegRPC gateway project structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
The issue is that protoc gen swagger outputs files to the same directory as the proto file instead of the directory specified via swagger out. To fix, investigate the output path logic in the generator code, likely in 'protoc gen swagger/main.go' or 'generator.go'. Look for how the output file path is constructed from the proto file path and the swagger out directory. The fix should ensure that the output directory is used as the base for the generated file.