We're on a mission to standardize message-based communication and increase interoperability of the different systems out there.
⚠️ This plugin doesn't support AsyncAPI 1.x
Gradle plugin helps to generate AsyncAPI specification from hand-crafted AsyncAPI class at choosed build cycle step.
- Generate AsyncAPI schema(s) for one or multiple Java classes.
- Generate AsyncAPI schemas for all classes in one or multiple packages.
- Generaty AsyncAPI schema in
json,yamlformat
plugins {
id 'com.asyncapi.asyncapi-gradle-plugin'
}
resolve {
packageNames = ['com.asyncapi.plugin.gradle.asyncapi.lamps', 'com.asyncapi.plugin.gradle.asyncapi.streetlights']
classPath = sourceSets.main.runtimeClasspath
}class Lamps(asyncapi: String = "2.0.0",
id: String? = null,
defaultContentType: String? = null,
info: Info = Info(),
servers: MutableMap<String, Server>? = null,
channels: MutableMap<String, ChannelItem> = mutableMapOf(),
components: Components? = null,
tags: MutableList<Tag>? = null,
externalDocs: ExternalDocumentation? = null
) : AsyncAPI(asyncapi, id, defaultContentType, info, servers, channels, components, tags, externalDocs) {
override fun getAsyncapi() = "2.0.0"
override fun getInfo(): Info {
return Info.builder()
.title("Lamps API")
.version("1.0.0")
.description("Recive real-time information about lamps")
.license(License.builder()
.name("Apache 2.0")
.url("https://www.apache.org/licenses/LICENSE-2.0")
.build()
)
.build()
}
override fun getServers(): MutableMap<String, Server> {
return mutableMapOf(
Pair("production", Server.builder()
.url("api.streetlights.smartylighting.com:{port}")
.protocol("mqtt")
.description("Test broker")
.variables(mapOf(
Pair("port", ServerVariable.builder()
.description("Secure connection (TLS) is available through port 8883.")
.defaultValue("1883")
.enumValue(listOf("1883", "8883"))
.build()
)
))
.security(listOf(
mapOf(Pair("apiKey", emptyList())),
mapOf(Pair("supportedOauthFlows", listOf(
"streetlights:on",
"streetlights:off",
"streetlights:dim")
)),
mapOf(Pair("openIdConnectWellKnown", emptyList()))
))
.build()
)
)
}
override fun getDefaultContentType() = "application/json"
override fun getChannels(): MutableMap<String, ChannelItem> {
return mutableMapOf(
Pair("smartylighting/lamps/1/0/event/{lampId}/info", ChannelItem.builder()
.description("The topic on which lamp info may be produced and consumed.")
.parameters(mapOf(
Pair("lampId", Reference("#/components/parameters/lampId"))
))
.subscribe(Operation.builder()
.summary("Receive information about lamp.")
.operationId("receiveLampInfo")
.traits(listOf(Reference("#/components/operationTraits/kafka")))
.message(Reference("#/components/messages/lampInfo"))
.build()
)
.build()
)
)
}
override fun getComponents(): Components? {
return Components.builder()
.messages(mapOf(
Pair("lampInfo", Message.builder()
.name("lampInfo")
.title("Lamp info")
.summary("Lamp information.")
.contentType("application/json")
.traits(listOf(Reference("#/components/messageTraits/commonHeaders")))
.payload(Reference("#/components/schemas/lampInfoPayload"))
.build())
))
.schemas(getSchemas())
.securitySchemes(getSecuritySchemes())
.parameters(getParameters())
.messageTraits(getMessageTraits())
.operationTraits(getOperationTraits())
.build()
}
private fun getSchemas(): Map<String, Any> {
return mapOf(
Pair("lampInfoPayload", Schema.builder()
.type(Type.OBJECT)
.properties(mapOf(
Pair("lumens", Schema.builder()
.type(Type.INTEGER)
.minimum(0)
.description("Lamp intensity measured in lumens.")
.build()
),
Pair("watts", Schema.builder()
.type(Type.INTEGER)
.minimum(0)
.maximum(100)
.description("Lamp watt consumption.")
.build())
))
.build()
)
)
}
private fun getSecuritySchemes(): Map<String, Any> {
return mapOf(
Pair("apiKey", ApiKeySecurityScheme.apiKeySecuritySchemeBuilder()
.type(SecurityScheme.Type.API_KEY)
.`in`(ApiKeySecurityScheme.ApiKeyLocation.USER)
.description("Provide your API key as the user and leave the password empty.")
.build()
)
)
}
private fun getParameters(): Map<String, Any> {
return mapOf(
Pair("lampId", Parameter.builder()
.description("The ID of the lamp.")
.schema(Schema.builder()
.type(Type.STRING)
.build()
)
.build())
)
}
private fun getMessageTraits(): Map<String, MessageTrait> {
return mapOf(
Pair("commonHeaders", MessageTrait.builder()
.headers(Schema.builder()
.type(Type.OBJECT)
.properties(mapOf(
Pair("my-app-header", Schema.builder()
.type(Type.INTEGER)
.minimum(0)
.maximum(100)
.build())
))
.build()
)
.build())
)
}
private fun getOperationTraits(): Map<String, OperationTrait> {
return mapOf(
Pair("kafka", OperationTrait.builder()
.bindings(mapOf(
Pair("kafka", KafkaOperationBinding.builder()
.clientId("my-app-id")
.build())
))
.build())
)
}
}Right now manual definition is the only way. Annotations with reflection for their handling will appear soon.