transform-swagger

command
v0.36.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 1, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

Transform Swagger

The Transform Swagger tool allows for customization of the swagger files under /specs.

The service swagger files are generated using the protoc-gen-openapiv2 protoc plugin, part of the grpc-gateway set of tools. The Go SDK generator tool go-swagger uses those swagger files to generate SDK clients and models.

In some cases, go-swagger needs additional data to generate a working SDK client. This is where this tool comes in to play. It first parses each swagger file into a mutable struct, applies any necessary changes, and then overwrites the json with the changes.

Transformations

  • Add x-go-type to shared type definitions: Type reusability across generated SDK clients requires the x-go-type extension to be added to every single shared type definition.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL