Generates API clients and models from OpenAPI specs for multiple targets, offering coroutine-based HTTP calls, JSON/date serialization, security support, named primitives, decorators and tag filtering.
This gradle plugin, the CLI (and companion library) are the successor of the jvm/android only plugin OpenAPI KGen. It comes with support for KMP and the targets JVM, Android, iOS, macOS, Windows and Linux.
Using the testspec.yaml file, the following code will be generated: generated/src
The plugin can be used by any JVM, Android or KMP project.
Modify your libs.versions.toml, add
[versions]
kmpgen = "<latest.version>"
# ...
[plugins]
kmpgen = { id = "com.kroegerama.openapi-kmp-gen", version.ref = "kmpgen" }
# ...
Register the plugin in your toplevel build.gradle.kts:
plugins {
alias(libs.plugins.kmpgen) apply false
// ...
}
Add the plugin in your module build.gradle.kts:
plugins {
alias(libs.plugins.kmpgen)
// ...
}
// ...
kmpgen {
spec(
packageName = "com.myproject.api"
) {
specFile = file("my-spec.yaml")
}
/* if you want to generate multiple specs
spec(
packageName = "com.myproject.api2"
) {
specFile = file("my-spec-2.yaml")
}
*/
}
The companion library is automatically added as a dependency, when the plugin is added. It centralizes the most important building blocks, all generated apis need. The library can be used by any project (KMP or non-KMP).
[versions]
kmpgen = "<latest.version>"
# ...
[libraries]
kmpgen-companion = { module = "com.kroegerama.openapi-kmp-gen:companion", version.ref = "kmpgen" }
# ...
If you just want to generate code without using a gradle plugin, the CLI can be used:
Copyright 2020 kroegerama
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
NAME
openapi-kmpgen generate - Generate code from the specified OpenAPI Spec.
SYNOPSIS
openapi-kmpgen generate [(-a | --generate-all-named-schemas)]
[--allow-parse-errors] [(-l <limit apis> | --limit-apis <limit apis>)]
(-o <output directory> | --output <output directory>)
[(-p <package name> | --package-name <package name>)]
[(-s | --output-src)] [(-v | --verbose)] [--] <spec file>
OPTIONS
-a, --generate-all-named-schemas
--allow-parse-errors
Try to generate classes, even if parsing errors occur in the spec.
-l <limit apis>, --limit-apis <limit apis>
If set, generate only these APIs (set via tag) and their models.
Comma separated list. Example: "auth,app"
-o <output directory>, --output <output directory>
-p <package name>, --package-name <package name>
-s, --output-src
-v, --verbose
--
This option can be used to separate command-line options from the
list of argument, (useful when arguments might be mistaken for
command-line options
<spec file>
Spec file (yaml/json). Can be a file or url.
Surfaced from shared tags and platforms — no rankings paid for.