Package io.swagger.codegen.v3.generators.java

Class SpringCodegen

java.lang.Object
io.swagger.codegen.v3.generators.DefaultCodegenConfig
io.swagger.codegen.v3.generators.java.AbstractJavaCodegen
io.swagger.codegen.v3.generators.java.SpringCodegen
All Implemented Interfaces:
io.swagger.codegen.v3.CodegenConfig, BeanValidationFeatures, NotNullAnnotationFeatures, OptionalFeatures
public class SpringCodegen extends AbstractJavaCodegen implements BeanValidationFeatures, OptionalFeatures, NotNullAnnotationFeatures

  • Field Details

  • Constructor Details

    • SpringCodegen

      public SpringCodegen()

  • Method Details

    • addCodegenContentParameters

      protected void addCodegenContentParameters(io.swagger.codegen.v3.CodegenOperation codegenOperation, List<io.swagger.codegen.v3.CodegenContent> codegenContents)
      Overrides:
      addCodegenContentParameters in class DefaultCodegenConfig

    • getTag

      public io.swagger.codegen.v3.CodegenType getTag()
      Specified by:
      getTag in interface io.swagger.codegen.v3.CodegenConfig

    • getName

      public String getName()
      Specified by:
      getName in interface io.swagger.codegen.v3.CodegenConfig

    • getHelp

      public String getHelp()
      Specified by:
      getHelp in interface io.swagger.codegen.v3.CodegenConfig

    • processOpts

      public void processOpts()
      Specified by:
      processOpts in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      processOpts in class AbstractJavaCodegen

    • fromProperty

      public io.swagger.codegen.v3.CodegenProperty fromProperty(String name, io.swagger.v3.oas.models.media.Schema propertySchema)
      Description copied from class: DefaultCodegenConfig
      Convert Swagger Property object to Codegen Property object
      Overrides:
      fromProperty in class DefaultCodegenConfig
      Parameters:
      name - name of the property
      propertySchema - Schema object
      Returns:
      Codegen Property object TODO : improve repeated code

    • addOperationToGroup

      public void addOperationToGroup(String tag, String resourcePath, io.swagger.v3.oas.models.Operation operation, io.swagger.codegen.v3.CodegenOperation co, Map<String,List<io.swagger.codegen.v3.CodegenOperation>> operations)
      Description copied from class: DefaultCodegenConfig
      Add operation to group
      Specified by:
      addOperationToGroup in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      addOperationToGroup in class DefaultCodegenConfig
      Parameters:
      tag - name of the tag
      resourcePath - path of the resource
      operation - Swagger Operation object
      co - Codegen Operation object
      operations - map of Codegen operations

    • getArgumentsLocation

      public String getArgumentsLocation()
      Overrides:
      getArgumentsLocation in class DefaultCodegenConfig

    • getDefaultTemplateDir

      public String getDefaultTemplateDir()
      Specified by:
      getDefaultTemplateDir in class DefaultCodegenConfig

    • preprocessOpenAPI

      public void preprocessOpenAPI(io.swagger.v3.oas.models.OpenAPI openAPI)
      Specified by:
      preprocessOpenAPI in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      preprocessOpenAPI in class AbstractJavaCodegen

    • postProcessOperations

      public Map<String,Object> postProcessOperations(Map<String,Object> objs)
      Specified by:
      postProcessOperations in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      postProcessOperations in class AbstractJavaCodegen

    • setNotNullJacksonAnnotation

      public void setNotNullJacksonAnnotation(boolean notNullJacksonAnnotation)
      Specified by:
      setNotNullJacksonAnnotation in interface NotNullAnnotationFeatures

    • isNotNullJacksonAnnotation

      public boolean isNotNullJacksonAnnotation()
      Specified by:
      isNotNullJacksonAnnotation in interface NotNullAnnotationFeatures

    • postProcessSupportingFileData

      public Map<String,Object> postProcessSupportingFileData(Map<String,Object> objs)
      Specified by:
      postProcessSupportingFileData in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      postProcessSupportingFileData in class DefaultCodegenConfig

    • toApiName

      public String toApiName(String name)
      Description copied from class: DefaultCodegenConfig
      Output the API (class) name (capitalized) ending with "Api" Return DefaultApi if name is empty
      Specified by:
      toApiName in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      toApiName in class AbstractJavaCodegen
      Parameters:
      name - the name of the Api
      Returns:
      capitalized Api name ending with "Api"

    • toApiTestFilename

      public String toApiTestFilename(String name)
      Description copied from class: DefaultCodegenConfig
      Return the file name of the Api Test
      Specified by:
      toApiTestFilename in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      toApiTestFilename in class AbstractJavaCodegen
      Parameters:
      name - the file name of the Api
      Returns:
      the file name of the Api

    • setParameterExampleValue

      public void setParameterExampleValue(io.swagger.codegen.v3.CodegenParameter p)
      Description copied from class: DefaultCodegenConfig
      Return the example value of the parameter.
      Overrides:
      setParameterExampleValue in class AbstractJavaCodegen
      Parameters:
      p - Swagger property object

    • setTitle

      public void setTitle(String title)

    • setConfigPackage

      public void setConfigPackage(String configPackage)

    • setValidationMode

      public void setValidationMode(String validationMode)

    • setBasePackage

      public void setBasePackage(String configPackage)

    • setInterfaceOnly

      public void setInterfaceOnly(boolean interfaceOnly)

    • setDelegatePattern

      public void setDelegatePattern(boolean delegatePattern)

    • setSingleContentTypes

      public void setSingleContentTypes(boolean singleContentTypes)

    • setJava8

      public void setJava8(boolean java8)

    • setJava11

      public void setJava11(boolean java11)

    • setAsync

      public void setAsync(boolean async)

    • setResponseWrapper

      public void setResponseWrapper(String responseWrapper)

    • setUseTags

      public void setUseTags(boolean useTags)

    • setImplicitHeaders

      public void setImplicitHeaders(boolean implicitHeaders)

    • setSwaggerDocketConfig

      public void setSwaggerDocketConfig(boolean swaggerDocketConfig)

    • postProcessModelProperty

      public void postProcessModelProperty(io.swagger.codegen.v3.CodegenModel model, io.swagger.codegen.v3.CodegenProperty property)
      Specified by:
      postProcessModelProperty in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      postProcessModelProperty in class AbstractJavaCodegen

    • postProcessAllModels

      public Map<String,Object> postProcessAllModels(Map<String,Object> objs)
      Specified by:
      postProcessAllModels in interface io.swagger.codegen.v3.CodegenConfig
      Overrides:
      postProcessAllModels in class DefaultCodegenConfig

    • modelInheritanceSupport

      protected List<Map<String,Object>> modelInheritanceSupport(List<?> allModels)

    • postProcessModelsEnum

      public Map<String,Object> postProcessModelsEnum(Map<String,Object> objs)
      Description copied from class: DefaultCodegenConfig
      post process enum defined in model's properties
      Overrides:
      postProcessModelsEnum in class DefaultCodegenConfig
      Parameters:
      objs - Map of models
      Returns:
      maps of models with better enum support

    • setUseBeanValidation

      public void setUseBeanValidation(boolean useBeanValidation)
      Specified by:
      setUseBeanValidation in interface BeanValidationFeatures

    • setUseOptional

      public void setUseOptional(boolean useOptional)
      Specified by:
      setUseOptional in interface OptionalFeatures

    • setOpenFeign

      public void setOpenFeign(boolean openFeign)

    • setDefaultInterfaces

      public void setDefaultInterfaces(boolean defaultInterfaces)

    • setThrowsException

      public void setThrowsException(boolean throwsException)