kora-openapi-generator-client

Kora OpenAPI Generator — HTTP Client

Kora sub-skill — obey the kora-v1 meta rules on every task: R0 ensure .kora-agent/ docs+examples are cloned · R1 read this sub-skill before writing code · R2 Kora APIs only — no Spring/Micronaut/Quarkus, no invented annotations or config keys · R3 journal any incorrect Kora usage. Add comments/Javadoc only if asked.

Generate a typed, declarative Kora HTTP client from an OpenAPI 3.x contract. The org.openapi.generator Gradle plugin with generatorName = "kora" emits a @HttpClient-backed *Api interface plus model records at build time. Inject the *Api into a @Component and call its methods.

This skill covers clients only. For OpenAPI server handlers (*-server modes, delegates, HttpServerPrincipalExtractor), use the kora-openapi-generator-server skill.

Quick Start

1. Plugin and buildscript dependency

buildscript {
    dependencies {
        classpath "ru.tinkoff.kora:openapi-generator:$koraVersion"
    }
}

plugins {
    id "java"
    id "application"
    id "org.openapi.generator" version "7.14.0" // pin exactly; other versions are not guaranteed compatible
}

2. Runtime modules

A generated client needs an HTTP client transport plus the JSON module. Pick one transport:

dependencies {
    koraBom platform("ru.tinkoff.kora:kora-parent:1.2.19")
    annotationProcessor "ru.tinkoff.kora:annotation-processors"   // MANDATORY — nothing generates without it

    implementation "ru.tinkoff.kora:http-client-jdk"   // JdkHttpClientModule (or http-client-ok / http-client-async)
    implementation "ru.tinkoff.kora:json-module"
    implementation "ru.tinkoff.kora:config-hocon"
    implementation "ru.tinkoff.kora:logging-logback"
}

@KoraApp plugs the transport module in:

@KoraApp
public interface Application extends
        HoconConfigModule,
        LogbackModule,
        JsonModule,
        JdkHttpClientModule {   // ru.tinkoff.kora.http.client.jdk.JdkHttpClientModule

    static void main(String[] args) {
        KoraApplication.run(ApplicationGraph::graph); // ru.tinkoff.kora.application.graph.KoraApplication
    }
}