search

kcl-lang / kcl-openapi

KCL OpenAPI Integration
https://kcl-lang.io/docs/tools/cli/openapi/
Apache License 2.0
8 stars 8 forks source link
kcl openapi swagger

readme

KCL OpenAPI

GoDoc license Coverage Status FOSSA Status

The work on this project is mainly based on go-swagger, and this project just adds some KCL-specific templates and language features to it. We are grateful and sincerely respectful for the outstanding work in go-swagger. Meanwhile, we are working on making the customized features separated from the basic OpenAPI logic in go-swagger.

Main use cases:

Features

The package translates Swagger OpenAPI spec and Kubernetes CRD to KCL models.

Translate Swagger OpenAPI Spec to KCL

The package now supports OpenAPI 2.0. By parsing the "Definitions" section of the spec, the KCL OpenAPI package will extract the defined models from it and generate the corresponding KCL representation.

Note: The Kubernetes KCL models among all versions are pre-generated, you get it by executing kcl mod add k8s:<version> under your project. Alternatively, if you may want to generate them yourself, please refer Generate KCL Packages from Kubernetes OpenAPI Specs.

Translate Kubernetes CRD to KCL

The package can also translate the Kubernetes CRD to KCL models. By parsing the spec.versions[n].schema.openAPIV3Schema (n means the latest version of the spec will be used) section of the CRD, the KCL OpenAPI package will extract the structural schema and generate the corresponding KCL representation.

KCL OpenAPI Spec

The KCL OpenAPI Spec defines a complete specification of how OpenAPI objects are mapped to KCL language elements.

License

Apache License Version 2.0

FOSSA Status