Documentation
¶
Index ¶
Constants ¶
View Source
const (
// DefaultOutputFileName is the default output file name for the generated openapi functions.
DefaultOutputFileName = "zz_generated.openapi.go"
)
Variables ¶
View Source
var ( // DefaultOutputPackagePath is the default output package path for the generated openapi functions. DefaultOutputPackagePath = filepath.Join("openapi", "generated_openapi") )
Functions ¶
func NewGenerator ¶
func NewGenerator(opts Options) generation.MultiGroupGenerator
NewGenerator builds a new openapi generator.
Types ¶
type Options ¶
type Options struct {
// HeaderFilePath is the path to the file containing the boilerplate header text.
// When omitted, no header is added to the generated files.
HeaderFilePath string
// OutputFileName is the name of the output file.
// When omitted, DefaultOutputFileName is used.
// The current value of DefaultOutputFileName is "zz_generated.openapi.go".
OutputFileName string
// OutputPackagePath is the package path where the generated golang files will be written.
OutputPackagePath string
// Verify determines whether the generator should verify the content instead
// of updating the generated file.
Verify bool
}
Options contains the configuration required for the compatibility generator.
Source Files
Click to show internal directories.
Click to hide internal directories.