Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Optional generation of separate swagger file #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2020
Merged

Optional generation of separate swagger file #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions cmd/protoc-gen-goclay/genhandler/handler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,31 @@ func (g *Generator) generateDesc(file *descriptor.File) (*plugin.CodeGeneratorRe
}, nil
}

func (g *Generator) generateSwaggerFile(file *descriptor.File) *plugin.CodeGeneratorResponse_File {
if g.options.SwaggerPath == "" || len(g.options.SwaggerDef) == 0 {
return nil
}

swaggerContent := g.options.SwaggerDef[file.GetName()]
if swaggerContent == nil {
return nil
}

name := filepath.Base(file.GetName())
ext := filepath.Ext(name)
base := strings.TrimSuffix(name, ext)

output := fmt.Sprintf(filepath.Join(g.options.SwaggerPath, "%s.json"), base)
output = filepath.Clean(output)

glog.V(1).Infof("Will emit %s", output)

return &plugin.CodeGeneratorResponse_File{
Name: proto.String(output),
Content: proto.String(string(swaggerContent)),
}
}

func (g *Generator) generateImpl(file *descriptor.File) (files []*plugin.CodeGeneratorResponse_File, err error) {
guessModule()
var pkg *ast.Package
Expand Down Expand Up @@ -242,6 +267,10 @@ func (g *Generator) Generate(targets []*descriptor.File) ([]*plugin.CodeGenerato
return nil, err
}

if swaggerFile := g.generateSwaggerFile(file); swaggerFile != nil {
files = append(files, swaggerFile)
}

if g.options.Impl {
if code, err := g.generateImpl(file); err == nil {
files = append(files, code...)
Expand Down
8 changes: 8 additions & 0 deletions cmd/protoc-gen-goclay/genhandler/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ type options struct {
ImplPath string
DescPath string
SwaggerDef map[string][]byte
SwaggerPath string
Impl bool
Force bool
ServiceSubDir bool
Expand All @@ -21,6 +22,13 @@ func SwaggerDef(swaggerDef map[string][]byte) Option {
}
}

// SwaggerPath sets path to store separate swagger files
func SwaggerPath(swaggerPath string) Option {
return func(o *options) {
o.SwaggerPath = swaggerPath
}
}

// ApplyDefaultMiddlewares toggles application of httpruntime/httpmw.DefaultChain to
// every generated handler.
func ApplyDefaultMiddlewares(apply bool) Option {
Expand Down
5 changes: 5 additions & 0 deletions cmd/protoc-gen-goclay/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ var (
grpcAPIConfiguration = flag.String("grpc_api_configuration", "", "path to gRPC API Configuration in YAML format")
withImpl = flag.Bool("impl", false, "generate simple implementations for proto Services. Implementation will not be generated if it already exists. See also `force` option")
withSwagger = flag.Bool("swagger", true, "generate swagger.json")
withSwaggerPath = flag.String("swagger_path", "", "in addition to swagger in pb.goclay.go, generate separate swagger file at provided path")
applyHTTPMiddlewares = flag.Bool("http_middlewares", true, "apply default HTTP millewares")
implPath = flag.String("impl_path", "", "path where the implementation is generated (for impl = true)")
forceImpl = flag.Bool("force", false, "force regenerate implementation if it already exists (for impl = true)")
Expand Down Expand Up @@ -112,6 +113,10 @@ func main() {
opts = append(opts, genhandler.SwaggerDef(swagBuf))
}

if *withSwaggerPath != "" {
opts = append(opts, genhandler.SwaggerPath(*withSwaggerPath))
}

g := genhandler.New(reg, opts...)

var targets []*descriptor.File
Expand Down