TapikGenerateTask

@CacheableTask
abstract class TapikGenerateTask : DefaultTask(source)

Gradle task that scans compiled classes for Tapik endpoints and generates supporting artefacts.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:Input
abstract val additionalClassDirectories: ListProperty<String>

Additional class directories (for example, from other projects) to include on the analysis classpath.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
@get:Optional
abstract val compiledClassesDirectory: DirectoryProperty

Directory holding compiled classes associated with the project under analysis.

Link copied to clipboard
@get:Input
abstract val enabledGeneratorIds: SetProperty<String>

Identifiers of generators that should be executed.

Link copied to clipboard
@get:Input
abstract val endpointPackages: ListProperty<String>

Packages that will be scanned for compiled HttpEndpoint declarations.

Link copied to clipboard
@get:OutputDirectory
abstract val generatedSourcesDirectory: DirectoryProperty

Directory where generated client source files are written.

Link copied to clipboard
@get:OutputDirectory
abstract val outputDirectory: DirectoryProperty

Directory containing the textual endpoint summary output.

Link copied to clipboard
@get:InputFiles
@get:PathSensitive(value = PathSensitivity.NONE)
abstract val runtimeClasspath: ConfigurableFileCollection

Runtime classpath used when analysing endpoint bytecode via reflection fallback.

Link copied to clipboard
@get:InputDirectory
@get:PathSensitive(value = PathSensitivity.RELATIVE)
abstract val sourceDirectory: DirectoryProperty

Source directory containing the Kotlin declarations that define Tapik endpoints.

Functions

Link copied to clipboard
fun generate()

Executes endpoint discovery and generates Tapik metadata and client sources.