Skip to main content

Documentation for the go-server Generator

METADATA

PropertyValueNotes
generator namego-serverpass this to the generate command after -g
generator stabilitySTABLE
generator typeSERVER
generator languageGo
generator default templating enginemustache
helpTxtGenerates a Go server library using OpenAPI-Generator. By default, it will also generate service classes -- which you can disable with the -Dnoservice environment variable.

CONFIG OPTIONS

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

OptionDescriptionValuesDefault
addResponseHeadersTo include response headers in ImplResponsefalse
enumClassPrefixPrefix enum with class namefalse
featureCORSEnable Cross-Origin Resource Sharing middlewarefalse
hideGenerationTimestampHides the generation timestamp when files are generated.true
onlyInterfacesExclude default service creators from output; only generate interfacesfalse
outputAsLibraryExclude main.go, go.mod, and Dockerfile from outputfalse
packageNameGo package name (convention: lowercase).openapi
packageVersionGo package version.1.0.0
routerSpecify the router which should be used.
mux
mux
chi
chi
mux
serverPortThe network port the generated server binds to8080
sourceFoldersource folder for generated codego

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated By

LANGUAGE PRIMITIVES

  • bool
  • byte
  • complex128
  • complex64
  • float32
  • float64
  • int
  • int32
  • int64
  • interface
  • map[string]interface
  • rune
  • string
  • uint
  • uint32
  • uint64

RESERVED WORDS

  • bool
  • break
  • byte
  • case
  • chan
  • complex128
  • complex64
  • const
  • continue
  • default
  • defer
  • else
  • error
  • fallthrough
  • float32
  • float64
  • for
  • func
  • go
  • goto
  • if
  • import
  • int
  • int16
  • int32
  • int64
  • int8
  • interface
  • map
  • nil
  • package
  • range
  • return
  • rune
  • select
  • string
  • struct
  • switch
  • type
  • uint
  • uint16
  • uint32
  • uint64
  • uint8
  • uintptr
  • var

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePathToolingExtension
AuthorizationsToolingExtension
UserAgentToolingExtension
MockServerToolingExtension

Data Type Feature

NameSupportedDefined By
CustomOAS2,OAS3
Int32OAS2,OAS3
Int64OAS2,OAS3
FloatOAS2,OAS3
DoubleOAS2,OAS3
DecimalToolingExtension
StringOAS2,OAS3
ByteOAS2,OAS3
BinaryOAS2,OAS3
BooleanOAS2,OAS3
DateOAS2,OAS3
DateTimeOAS2,OAS3
PasswordOAS2,OAS3
FileOAS2
Uuid
ArrayOAS2,OAS3
NullOAS3
AnyTypeOAS2,OAS3
ObjectOAS2,OAS3
MapsToolingExtension
CollectionFormatOAS2
CollectionFormatMultiOAS2
EnumOAS2,OAS3
ArrayOfEnumToolingExtension
ArrayOfModelToolingExtension
ArrayOfCollectionOfPrimitivesToolingExtension
ArrayOfCollectionOfModelToolingExtension
ArrayOfCollectionOfEnumToolingExtension
MapOfEnumToolingExtension
MapOfModelToolingExtension
MapOfCollectionOfPrimitivesToolingExtension
MapOfCollectionOfModelToolingExtension
MapOfCollectionOfEnumToolingExtension

Documentation Feature

NameSupportedDefined By
ReadmeToolingExtension
ModelToolingExtension
ApiToolingExtension

Global Feature

NameSupportedDefined By
HostOAS2,OAS3
BasePathOAS2,OAS3
InfoOAS2,OAS3
SchemesOAS2,OAS3
PartialSchemesOAS2,OAS3
ConsumesOAS2
ProducesOAS2
ExternalDocumentationOAS2,OAS3
ExamplesOAS2,OAS3
XMLStructureDefinitionsOAS2,OAS3
MultiServerOAS3
ParameterizedServerOAS3
ParameterStylingOAS3
CallbacksOAS3
LinkObjectsOAS3

Parameter Feature

NameSupportedDefined By
PathOAS2,OAS3
QueryOAS2,OAS3
HeaderOAS2,OAS3
BodyOAS2
FormUnencodedOAS2
FormMultipartOAS2
CookieOAS3

Schema Support Feature

NameSupportedDefined By
SimpleOAS2,OAS3
CompositeOAS2,OAS3
PolymorphismOAS2,OAS3
UnionOAS3
allOfOAS2,OAS3
anyOfOAS3
oneOfOAS3
notOAS3

Security Feature

NameSupportedDefined By
BasicAuthOAS2,OAS3
ApiKeyOAS2,OAS3
OpenIDConnectOAS3
BearerTokenOAS3
OAuth2_ImplicitOAS2,OAS3
OAuth2_PasswordOAS2,OAS3
OAuth2_ClientCredentialsOAS2,OAS3
OAuth2_AuthorizationCodeOAS2,OAS3
SignatureAuthOAS3
AWSV4SignatureToolingExtension

Wire Format Feature

NameSupportedDefined By
JSONOAS2,OAS3
XMLOAS2,OAS3
PROTOBUFToolingExtension
CustomOAS2,OAS3