com.ancientlightstudios.quarkus.kotlin.openapi.Config.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quarkus-kotlin-openapi-maven-plugin Show documentation
A Maven plugin to use the OpenAPI generator.
There is a newer version: 0.5.0
Show newest version
package com.ancientlightstudios.quarkus.kotlin.openapi

import com.ancientlightstudios.quarkus.kotlin.openapi.models.kotlin.ClassName
import com.ancientlightstudios.quarkus.kotlin.openapi.models.kotlin.ClassName.Companion.rawClassName
import com.ancientlightstudios.quarkus.kotlin.openapi.utils.ConfigIssue

enum class InterfaceType {
    SERVER, CLIENT
}

class Config(
    /**
     * The source files to parse.
     */
    val sourceFiles: List,

    /**
     * The JSON-Patch files to apply to the OpenAPI specification.
     */
    val patchFiles: List,

    /**
     * Path where the debug output should be written.
     */
    val debugOutputFile: String? = null,

    /**
     * The name of the interface to generate.
     */
    val interfaceName: String,
    /**
     * The package name of the generated classes.
     */
    val packageName: String,

    /**
     * Additional package/class imports that should be included. These can contain custom validators or custom type converters.
     * Format:
     * - 
     * - com.example:Foo
     * - com.example.bar:*
     */
    private val additionalImports: List,

    /**
     * The directory where the generated sources should be put
     */
    val outputDirectory: String,

    /**
     * Path prefix to be prepended to generated endpoints.
     */
    val pathPrefix: String = "",

    /**
     * The endpoints of the API for which the interface should be generated.
     * If empty, all endpoints are used.
     * Format:
     * - /openapi/subscription/{SearchTerm} -> matches exactly this endpoint (all methods)
     * - /openapi/subscription/{SearchTerm}:get -> matches only the GET method of this endpoint
     * - /openapi/subscription/{SearchTerm}:get,post -> matches only the GET and POST method of this endpoint
     */
    val endpoints: List = emptyList(),

    val splitByTags: Boolean = false,

    /**
     * The custom type mappings to use for the generated interface.
     * Format:
     * - :=
     * - string:uuid=java.util:UUID
     */
    private val typeMappings: List,

    /**
     * Custom content type mappings to use for the generated interface. Requests and responses will still use the
     * content type defined in the spec, but the generator knows how to handle these content types.
     * Format:
     * - =
     * - application/jrd+json=application/json
     */
    private val contentTypeMappings: List,

    /**
     * The type of the interface to generate.
     */
    val interfaceType: InterfaceType,

    /**
     * A list of additional provider classes which should be added as @RegisterProvider annotations to the generated interface.
     */
    private val additionalProviders: List = listOf()
) {

    fun additionalImports() = additionalImports.map { it.toRawClassName("Illegal value for additional import $it") }

    fun typeNameFor(type: String, format: String): ClassName? {
        val mapping = typeMappings.firstOrNull { it.startsWith("$type:$format=") }?.substringAfter("=") ?: return null
        return mapping.toRawClassName("Illegal value for type mapping $type:$format")
    }

    fun contentTypeFor(contentType: String): String? {
        return contentTypeMappings.firstOrNull { it.startsWith("$contentType=") }?.substringAfter("=")
    }

    fun additionalProviders() = additionalProviders.map { it.toRawClassName("Illegal value for additional provider $it") }

    private fun String.toRawClassName(errorMessage: String): ClassName {
        val parts = split(':', limit = 2)
        if (parts.size != 2) {
            ConfigIssue(errorMessage)
        }
        return parts[1].rawClassName(parts[0])
    }

}