Skip to content

Repository files navigation

Module OpenAPI-kt

Maven Central License

WORK IN PROGRESS

OpenAPI-kt is a toolset for working with OpenAPI in Kotlin. This project exists out of several pieces, and they can be combined in different ways to achieve different goals.

  • parser: A OpenAPI parser, and typed ADT based on KotlinX Serialization
  • typed: A version of the Core ADT, structures the data in a convenient way to retrieve.
  • renderer: A code generator that generates code from the OpenAPI Typed ADT
  • gradle-plugin: Gradle plugin to conveniently generate clients

Code Generation

Add the following to your build.gradle.kts file.

plugin {
    id("io.github.nomisrev:openapi-kt-gradle-plugin") version "0.0.9"
}

configure<OpenApiExtension> {
    specFile.set(rootProject.file("youtrack.json"))
}

Then run the following command to generate the code, but it will also automatically run when you build your project.

./gradlew generateOpenApi

This will generate a io.github.nomisrev.youtrack package with the generated code, in your /build/generated directory.

About

Kotlin Multiplatform Typed OpenAPI Document Parser (KotlinX) with Typed Secondary Custom ADT for inspection, typed transformations, code generation, etc.

Resources

Stars

24 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages