Package org.openapitools.codegen.languages

Class PythonFastAPIServerCodegen

java.lang.Object

org.openapitools.codegen.DefaultCodegen

org.openapitools.codegen.languages.AbstractPythonCodegen

org.openapitools.codegen.languages.PythonFastAPIServerCodegen

All Implemented Interfaces:

CodegenConfig

public class PythonFastAPIServerCodegen
extends AbstractPythonCodegen

Field Summary

Fields

Modifier and Type	Field	Description
protected String	sourceFolder

Fields inherited from class org.openapitools.codegen.languages.AbstractPythonCodegen

packageName, packageVersion, projectName

Fields inherited from class org.openapitools.codegen.DefaultCodegen

additionalProperties, addOneOfInterfaceImports, addOneOfInterfaces, addSuffixToDuplicateOperationNicknames, allowUnicodeIdentifiers, apiDocTemplateFiles, apiNamePrefix, apiNameSuffix, apiPackage, apiTemplateFiles, apiTestTemplateFiles, cliOptions, DefaultFeatureSet, defaultIncludes, disallowAdditionalPropertiesIfNotPresent, docExtension, embeddedTemplateDir, enableMinimalUpdate, enablePostProcessFile, ensureUniqueParams, enumUnknownDefaultCase, enumUnknownDefaultCaseName, falseSchema, filesMetadataFilename, fileSuffix, generatorMetadata, gitHost, gitRepoId, gitUserId, hideGenerationTimestamp, httpUserAgent, ignoreFilePathOverride, importBaseType, importContainerType, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, inputSpec, instantiationTypes, JSON_MIME_PATTERN, JSON_VENDOR_MIME_PATTERN, languageSpecificPrimitives, legacyDiscriminatorBehavior, library, loadDeepObjectIntoItems, modelDocTemplateFiles, modelNamePrefix, modelNameSuffix, modelPackage, modelTemplateFiles, modelTestTemplateFiles, openAPI, openapiNormalizer, outputFolder, prependFormOrBodyParameters, releaseNote, removeEnumValuePrefix, removeOperationIdPrefix, removeOperationIdPrefixCount, removeOperationIdPrefixDelimiter, reservedWords, reservedWordsMappings, schemaMapping, serverVariables, skipOperationExample, skipOverwrite, sortModelPropertiesByRequiredFlag, sortParamsByRequiredFlag, specialCharReplacements, strictSpecBehavior, supportedLibraries, supportingFiles, supportsAdditionalPropertiesWithComposedSchema, supportsInheritance, supportsMixins, supportsMultipleInheritance, templateDir, testPackage, trueSchema, typeAliases, typeMapping, useOneOfInterfaces, vendorExtensions, versionMetadataFilename

Constructor Summary

Constructors

Constructor	Description
PythonFastAPIServerCodegen()

Method Summary

Modifier and Type	Method	Description
String	apiFileFolder()
String	generatorLanguageVersion()
String	getHelp()
String	getName()
CodegenType	getTag()
String	getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)	Output the language-specific type declaration of the property.
String	modelFileFolder()
void	postProcess()
Map<String,ModelsMap>	postProcessAllModels(Map<String,ModelsMap> objs)
OperationsMap	postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels)
Map<String,Object>	postProcessSupportingFileData(Map<String,Object> objs)
void	processOpts()
String	toModelImport(String name)	Return the fully-qualified "Model" name for import
String	toRegularExpression(String pattern)	Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)

Methods inherited from class org.openapitools.codegen.languages.AbstractPythonCodegen

dropDots, escapeQuotationMark, escapeReservedWord, escapeUnsafeCharacters, generatorLanguage, getSchemaType, patternCorrection, postProcessFile, sanitizeTag, setPackageName, setPackageVersion, setParameterExampleValue, setParameterExampleValue, setProjectName, toApiFilename, toApiName, toApiTestFilename, toApiVarName, toDefaultValue, toExampleValue, toModelFilename, toModelName, toModelTestFilename, toOperationId, toParamName, toVarName

Methods inherited from class org.openapitools.codegen.DefaultCodegen

addAdditionPropertiesToCodeGenModel, addBodyModelSchema, addHeaders, addImport, addImport, addImport, addImports, addImports, addImports, addImportsForPropertyType, addImportsToOneOfInterface, additionalProperties, addMustacheLambdas, addOneOfInterfaceModel, addOneOfNameExtension, addOperationToGroup, addOption, addOption, addParentContainer, addProperties, addRegularExpressionDelimiter, addRequiredVarsMap, addSwitch, addVars, addVars, addVarsRequiredVarsAdditionalProps, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, buildEnumVars, buildLibraryCliOption, cliOptions, convertPropertyToBoolean, convertPropertyToBooleanAndWriteBack, createDiscriminator, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, findCommonPrefixOfVars, findMethodResponse, fromCallback, fromFormProperty, fromModel, fromOperation, fromParameter, fromProperty, fromProperty, fromProperty, fromRequestBody, fromRequestBodyToFormParameters, fromResponse, fromSecurity, fromServers, fromServerVariables, generateExamplePath, generateJSONSpecFile, generateYAMLSpecFile, getAdditionalProperties, getAdditionalPropertiesName, getAddSuffixToDuplicateOperationNicknames, getAlias, getAllModels, getAllOfDescendants, getAllowUnicodeIdentifiers, getApiNamePrefix, getApiNameSuffix, getCollectionFormat, getCollectionFormat, getConsumesInfo, getContent, getContentType, getDisallowAdditionalPropertiesIfNotPresent, getDocExtension, getEnsureUniqueParams, getEnumDefaultValue, getEnumUnknownDefaultCase, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInnerEnumAllowableValues, getInputSpec, getItemsName, getLegacyDiscriminatorBehavior, getLibrary, getModelNamePrefix, getModelNameSuffix, getModelNameToSchemaCache, getMostInnerItems, getOneOfAnyOfDescendants, getOrGenerateOperationId, getOutputDir, getParameterDataType, getPrependFormOrBodyParameters, getProducesInfo, getReleaseNote, getRemoveOperationIdPrefixCount, getRemoveOperationIdPrefixDelimiter, getSchemaAdditionalProperties, getSchemaFromBooleanOrSchema, getSchemaItems, getSingleSchemaType, getSortModelPropertiesByRequiredFlag, getSortParamsByRequiredFlag, getSupportedVendorExtensions, getSymbolName, getTemplatingEngine, getterAndSetterCapitalize, getTypeDeclaration, getUseInlineModelResolver, getUseOneOfInterfaces, getUseOpenAPINormalizer, getVersionMetadataFilename, handleMethodResponse, handleMethodResponse, handleSpecialCharacters, hasBodyParameter, hasFormParameter, importMapping, initializeSpecialCharacterMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isAnyTypeSchema, isDataTypeBinary, isDataTypeFile, isDataTypeString, isEnableMinimalUpdate, isEnablePostProcessFile, isFreeFormObject, isHideGenerationTimestamp, isJsonMimeType, isJsonVendorMimeType, isLibrary, isParameterNameUnique, isPropertyInnerMostEnum, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isReservedWord, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, lowerCamelCase, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, modifyFeatureSet, needToImport, openapiNormalizer, outputFolder, postProcessModelProperty, postProcessModels, postProcessModelsEnum, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, processTestExampleData, removeImport, removeNonNameElementToCamelCase, removeNonNameElementToCamelCase, removeOption, removeSelfReferenceImports, reservedWords, reservedWordsMappings, sanitizeName, sanitizeName, sanitizeName, schemaMapping, serverVariableOverrides, setAddProps, setAllowUnicodeIdentifiers, setApiNamePrefix, setApiNameSuffix, setApiPackage, setCircularReferences, setDisallowAdditionalPropertiesIfNotPresent, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setEnsureUniqueParams, setEnumUnknownDefaultCase, setFilesMetadataFilename, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLegacyDiscriminatorBehavior, setLibrary, setModelNamePrefix, setModelNameSuffix, setModelPackage, setNonArrayMapProperty, setOpenAPI, setOutputDir, setParameterBooleanFlagWithCodegenProperty, setParameterEncodingValues, setParameterExamples, setParameterExampleValue, setParameterNullable, setPrependFormOrBodyParameters, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setRemoveOperationIdPrefixCount, setRemoveOperationIdPrefixDelimiter, setReservedWordsLowerCase, setSkipOperationExample, setSkipOverwrite, setSortModelPropertiesByRequiredFlag, setSortParamsByRequiredFlag, setStrictSpecBehavior, setTemplateDir, setTemplatingEngine, setUseOneOfInterfaces, setVersionMetadataFilename, shouldAddImport, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toAllOfName, toAnyOfName, toApiDocFilename, toApiImport, toArrayModelParamName, toBooleanGetter, toDefaultParameterValue, toDefaultParameterValue, toDefaultValue, toDefaultValueWithParam, toEnumDefaultValue, toEnumName, toEnumValue, toEnumVarName, toExamples, toGetter, toInstantiationType, toMediaTypeSchemaName, toModelDocFilename, toModelImportMap, toOneOfName, toSetter, toTestCaseName, typeMapping, unaliasPropertySchema, unaliasSchema, updateAllModels, updateCodegenPropertyEnum, updateDataTypeWithEnumForArray, updateDataTypeWithEnumForMap, updateEnumVarsWithExtensions, updateModelForAnyType, updateModelForComposedSchema, updateModelForInteger, updateModelForNumber, updateModelForObject, updateModelForString, updateOption, updateParameterForString, updatePropertyForAnyType, updatePropertyForArray, updatePropertyForInteger, updatePropertyForMap, updatePropertyForMap, updatePropertyForNumber, updatePropertyForObject, updatePropertyForString, updateRequestBodyForArray, updateRequestBodyForMap, updateRequestBodyForObject, updateRequestBodyForPrimitiveType, updateRequestBodyForString, vendorExtensions, writePropertyBack

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openapitools.codegen.CodegenConfig

additionalProperties, addOperationToGroup, apiDocFileFolder, apiDocFilename, apiDocTemplateFiles, apiFilename, apiPackage, apiTemplateFiles, apiTestFileFolder, apiTestFilename, apiTestTemplateFiles, cliOptions, defaultIncludes, defaultTemplatingEngine, embeddedTemplateDir, encodePath, escapeText, escapeTextWhileAllowingNewLines, fileSuffix, fromModel, fromOperation, fromSecurity, fromServers, fromServerVariables, generateExamplePath, getAddSuffixToDuplicateOperationNicknames, getDocExtension, getFeatureSet, getFilesMetadataFilename, getGeneratorMetadata, getGitHost, getGitRepoId, getGitUserId, getHttpUserAgent, getIgnoreFilePathOverride, getInputSpec, getLibrary, getOutputDir, getReleaseNote, getSupportedVendorExtensions, getTemplatingEngine, getTypeDeclaration, getUseInlineModelResolver, getUseOpenAPINormalizer, getVersionMetadataFilename, importMapping, inlineSchemaNameDefault, inlineSchemaNameMapping, instantiationTypes, isEnableMinimalUpdate, isEnablePostProcessFile, isHideGenerationTimestamp, isRemoveEnumValuePrefix, isRemoveOperationIdPrefix, isSkipOperationExample, isSkipOverwrite, isStrictSpecBehavior, languageSpecificPrimitives, modelDocFileFolder, modelDocTemplateFiles, modelFilename, modelPackage, modelTemplateFiles, modelTestFileFolder, modelTestTemplateFiles, openapiNormalizer, outputFolder, postProcessModelProperty, postProcessModels, postProcessParameter, preprocessOpenAPI, processCompiler, processOpenAPI, processTemplatingEngine, reservedWords, reservedWordsMappings, sanitizeName, schemaMapping, serverVariableOverrides, setDocExtension, setEnableMinimalUpdate, setEnablePostProcessFile, setGitHost, setGitRepoId, setGitUserId, setHideGenerationTimestamp, setHttpUserAgent, setIgnoreFilePathOverride, setInputSpec, setLibrary, setOpenAPI, setOutputDir, setReleaseNote, setRemoveEnumValuePrefix, setRemoveOperationIdPrefix, setSkipOperationExample, setSkipOverwrite, setStrictSpecBehavior, setTemplatingEngine, shouldOverwrite, supportedLibraries, supportingFiles, templateDir, testPackage, toApiDocFilename, toApiImport, toBooleanGetter, toGetter, toModelDocFilename, toModelImportMap, toSetter, typeMapping, unaliasSchema, updateAllModels, vendorExtensions

Field Detail

sourceFolder

protected String sourceFolder

Constructor Detail

PythonFastAPIServerCodegen

public PythonFastAPIServerCodegen()

Method Detail

getTag

public CodegenType getTag()

Specified by:

getTag in interface CodegenConfig

Overrides:

getTag in class DefaultCodegen

getHelp

public String getHelp()

Specified by:

getHelp in interface CodegenConfig

Overrides:

getHelp in class DefaultCodegen

processOpts

public void processOpts()

Specified by:

processOpts in interface CodegenConfig

Overrides:

processOpts in class AbstractPythonCodegen

getName

public String getName()

Specified by:

getName in interface CodegenConfig

Overrides:

getName in class DefaultCodegen

toModelImport

public String toModelImport(String name)

Description copied from class: DefaultCodegen

Return the fully-qualified "Model" name for import

Specified by:

toModelImport in interface CodegenConfig

Overrides:

toModelImport in class DefaultCodegen

Parameters:

name - the name of the "Model"

Returns:

the fully-qualified "Model" name for import

getTypeDeclaration

public String getTypeDeclaration(io.swagger.v3.oas.models.media.Schema p)

Description copied from class: DefaultCodegen

Output the language-specific type declaration of the property.

Specified by:

getTypeDeclaration in interface CodegenConfig

Overrides:

getTypeDeclaration in class DefaultCodegen

Parameters:

p - property schema

Returns:

a string presentation of the property type

postProcessOperationsWithModels

public OperationsMap postProcessOperationsWithModels(OperationsMap objs,
                                                     List<ModelMap> allModels)

Specified by:

postProcessOperationsWithModels in interface CodegenConfig

Overrides:

postProcessOperationsWithModels in class DefaultCodegen

postProcessAllModels

public Map<String,ModelsMap> postProcessAllModels(Map<String,ModelsMap> objs)

Specified by:

postProcessAllModels in interface CodegenConfig

Overrides:

postProcessAllModels in class DefaultCodegen

postProcessSupportingFileData

public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)

Specified by:

postProcessSupportingFileData in interface CodegenConfig

Overrides:

postProcessSupportingFileData in class DefaultCodegen

apiFileFolder

public String apiFileFolder()

Specified by:

apiFileFolder in interface CodegenConfig

Overrides:

apiFileFolder in class DefaultCodegen

modelFileFolder

public String modelFileFolder()

Specified by:

modelFileFolder in interface CodegenConfig

Overrides:

modelFileFolder in class DefaultCodegen

postProcess

public void postProcess()

Specified by:

postProcess in interface CodegenConfig

Overrides:

postProcess in class DefaultCodegen

toRegularExpression

public String toRegularExpression(String pattern)

Description copied from class: DefaultCodegen

Return the regular expression/JSON schema pattern (http://json-schema.org/latest/json-schema-validation.html#anchor33)

Overrides:

toRegularExpression in class AbstractPythonCodegen

Parameters:

pattern - the pattern (regular expression)

Returns:

properly-escaped pattern

generatorLanguageVersion

public String generatorLanguageVersion()

Specified by:

generatorLanguageVersion in interface CodegenConfig

Overrides:

generatorLanguageVersion in class DefaultCodegen