gOAst (@goast/kotlin)


gOAst stands for generative Open API specification transformer, a tool designed to transform
OpenAPI specifications into various forms with flexibility and extensibility at its core.

For more Information, please visit the gOAst GitHub Repository.

Purpose 👍

The @goast/kotlin package provides generators for Kotlin code generation from OpenAPI
specifications.

Usage Example 🚀

``typescript
import { OpenApiGenerator } from '@goast/core';
import { KotlinModelsGenerator, KotlinSpringControllersGenerator } from '@goast/kotlin';

async function main() {
await new OpenApiGenerator({ outputDir: '.api' })
.useType(KotlinModelsGenerator)
.useType(KotlinSpringControllersGenerator)
.parseAndGenerateFromDir('.openapi');
}

main();
`

Available Generators 📚

- KotlinModelsGenerator: Generates Kotlin data
classes from schemas in the OpenAPI specification(s).
- KotlinSpringControllersGenerator:
Generates Spring controllers for Kotlin from paths in the OpenAPI specification(s).
- Depends on the output of the KotlinModelsGenerator generator.
- KotlinOkHttp3ClientsGenerator:
Generates OkHttp3 clients for Kotlin from paths in the OpenAPI specification(s).
- Depends on the output of the KotlinModelsGenerator` generator.

API Documentation 📖

The API documentation can be found here.