openapi

Documentation

Index

• Variables
• func GenerateOpenapi(spec *spec.Spec, outFile string) *generator.CodeFile
• func OpenApiType(types ...*spec.TypeDef) *yamlx.YamlMap
• func PlainOpenApiType(typeInfo *spec.TypeInfo, typ string) *yamlx.YamlMap
• type UrlOperations
  • func OperationsByUrl(specification *spec.Spec) []*UrlOperations

Variables

var Openapi = generator.Generator{
	"openapi",
	"OpenAPI v3",
	"Generate OpenAPI specification",
	[]generator.GeneratorArg{
		{Arg: generator.ArgSpecFile, Required: true},
		{Arg: generator.ArgOutFile, Required: true},
	},
	func(specification *spec.Spec, params generator.GeneratorArgsValues) *generator.Sources {
		openapiFile := GenerateOpenapi(specification, params[generator.ArgOutFile])
		sources := generator.NewSources()
		sources.AddGenerated(openapiFile)
		return sources
	},
}

Functions

func GenerateOpenapi

func GenerateOpenapi(spec *spec.Spec, outFile string) *generator.CodeFile

func OpenApiType

func OpenApiType(types ...*spec.TypeDef) *yamlx.YamlMap

func PlainOpenApiType

func PlainOpenApiType(typeInfo *spec.TypeInfo, typ string) *yamlx.YamlMap

Types

type UrlOperations

type UrlOperations struct {
	Url        string
	Operations []*spec.NamedOperation
}

func OperationsByUrl

func OperationsByUrl(specification *spec.Spec) []*UrlOperations