Function Generate

pkg/codegen/codegen.go:149–552

Generate uses the Go templating engine to generate all of our server wrappers from the descriptions we've built up above from the schema objects. opts defines

(spec *openapi3.T, opts Configuration)

// the descriptions we've built up above from the schema objects.
// opts defines
func Generate(spec *openapi3.T, opts Configuration) (string, error) {
	// This is global state
	globalState.options = opts
	globalState.spec = spec
	globalState.importMapping = constructImportMapping(opts.ImportMapping)
	if opts.OutputOptions.TypeMapping != nil {
		globalState.typeMapping = DefaultTypeMapping.Merge(*opts.OutputOptions.TypeMapping)
	} else {
		globalState.typeMapping = DefaultTypeMapping
	}

	filterOperationsByTag(spec, opts)
	filterOperationsByOperationID(spec, opts)
	if !opts.OutputOptions.SkipPrune {
		pruneUnusedComponents(spec)
	}

	// if we are provided an override for the response type suffix update it
	if opts.OutputOptions.ResponseTypeSuffix != "" {
		responseTypeSuffix = opts.OutputOptions.ResponseTypeSuffix
	}

	if globalState.options.OutputOptions.ClientTypeName == "" {
		globalState.options.OutputOptions.ClientTypeName = defaultClientTypeName
	}

	nameNormalizerFunction := NameNormalizerFunction(opts.OutputOptions.NameNormalizer)
	nameNormalizer = NameNormalizers[nameNormalizerFunction]
	if nameNormalizer == nil {
		return "", fmt.Errorf(`the name-normalizer option %v could not be found among options %q`,
			opts.OutputOptions.NameNormalizer, NameNormalizers.Options())
	}

	if nameNormalizerFunction != NameNormalizerFunctionToCamelCaseWithInitialisms && len(opts.OutputOptions.AdditionalInitialisms) > 0 {
		return "", fmt.Errorf("you have specified `additional-initialisms`, but the `name-normalizer` is not set to `ToCamelCaseWithInitialisms`. Please specify `name-normalizer: ToCamelCaseWithInitialisms` or remove the `additional-initialisms` configuration")
	}

	globalState.initialismsMap = makeInitialismsMap(opts.OutputOptions.AdditionalInitialisms)

	// Compile streaming-content-type patterns (defaults merged with user-supplied).
	// Validate() already caught syntax errors, but surface any regression here too.
	streamingRegexes, err := compileStreamingContentTypes(opts.OutputOptions.StreamingContentTypes)
	if err != nil {
		return "", err
	}
	globalState.streamingContentTypeRegexes = streamingRegexes

	// Multi-pass name resolution: gather all schemas, then resolve names globally.
	// Only enabled when resolve-type-name-collisions is set.
	if opts.OutputOptions.ResolveTypeNameCollisions {
		gathered := GatherSchemas(spec, opts)
		globalState.resolvedNames = ResolveNames(gathered)
		// Build a separate operationID -> wrapper name lookup for genResponseTypeName.
		// Keys must use the normalized operationID (via nameNormalizer) because
		// OperationDefinition.OperationId is normalized before templates run.
		globalState.resolvedClientWrapperNames = make(map[string]string)
		for _, gs := range gathered {
			if gs.Context == ContextClientResponseWrapper && gs.OperationID != "" {