Package org.springdoc.gradle.tasks

Class GenerateOpenApiTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.springdoc.gradle.tasks.GenerateOpenApiTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public abstract class GenerateOpenApiTask extends org.gradle.api.DefaultTask
Generates the OpenAPI specification by forking a dedicated JVM that boots the target Spring Boot application (WebFlux or WebMvc) against the application's own classpath, writes the spec to disk, and shuts the context down. Forking avoids contaminating the Gradle daemon or mixing classloaders.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Named

    org.gradle.api.Named.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    GenerateOpenApiTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    generate()
     
    org.gradle.api.file.ConfigurableFileCollection
    getClasspath()
     
    org.gradle.api.provider.Property<String>
    getFormat()
     
    org.gradle.api.file.ConfigurableFileCollection
    getGeneratorClasspath()
     
    org.gradle.api.file.RegularFileProperty
    getJavaExecutable()
    The java executable to use for the forked worker.
    org.gradle.api.provider.Property<String>
    getMainClass()
     
    org.gradle.api.file.DirectoryProperty
    getOutputDir()
     
    org.gradle.api.provider.Property<String>
    getOutputFileName()
     
    org.gradle.api.provider.MapProperty<String,String>
    getSystemProperties()
     
    org.gradle.api.provider.Property<Integer>
    getTimeoutSeconds()
    Upper bound (seconds) for the forked worker.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, notCompatibleWithConfigurationCache

  • Constructor Details

    • GenerateOpenApiTask

      @Inject public GenerateOpenApiTask()

  • Method Details

    • getClasspath

      @Classpath public org.gradle.api.file.ConfigurableFileCollection getClasspath()

    • getGeneratorClasspath

      @Classpath public org.gradle.api.file.ConfigurableFileCollection getGeneratorClasspath()

    • getOutputDir

      @OutputDirectory public org.gradle.api.file.DirectoryProperty getOutputDir()

    • getOutputFileName

      @Input @Optional public org.gradle.api.provider.Property<String> getOutputFileName()

    • getFormat

      @Input @Optional public org.gradle.api.provider.Property<String> getFormat()

    • getMainClass

      @Input @Optional public org.gradle.api.provider.Property<String> getMainClass()

    • getJavaExecutable

      @InputFile @Optional @PathSensitive(ABSOLUTE) public org.gradle.api.file.RegularFileProperty getJavaExecutable()
      The java executable to use for the forked worker. When the project applies the java plugin, this is wired to the compilation toolchain's launcher rather than the Gradle daemon JVM, keeping the worker on the same JDK as the application.

    • getTimeoutSeconds

      @Input @Optional public org.gradle.api.provider.Property<Integer> getTimeoutSeconds()
      Upper bound (seconds) for the forked worker. Defaults to 120.

    • getSystemProperties

      @Input @Optional public org.gradle.api.provider.MapProperty<String,String> getSystemProperties()

    • generate

      public void generate()