crdtoapi
: From CustomResourceDefinitions to TypeScript APIWelcome to crdtoapi - a powerful suite of tools designed to effortlessly convert OpenAPI and kubernetes CustomResourceDefinitions (CRDs) into TypeScript interfaces and constants. Streamline your development process by automating the generation of TypeScript definitions directly from CRD files, saving time and minimizing potential errors.
The evolution of applications and services in the Kubernetes ecosystem has resulted in the need for precise and consistent TypeScript typings. With crdtoapi, developers can ensure type accuracy without the repetitive task of manual definition writing. Dive into our tools to understand how you can benefit from them.
crdtoapi
Description: Generate OpenAPI definition files directly from Kubernetes CustomResourceDefinitions.
Learn more
crdtomodel
Description: Craft TypeScript constants seamlessly from Kubernetes CustomResourceDefinitions.
Learn more
crdtotypes
Description: Transform OpenAPI definitions into robust TypeScript interfaces.
Learn more
Whether you're a seasoned Kubernetes pro or just venturing into the world of OpenAPI, crdtoapi
is tailored to offer an intuitive and developer-friendly experience. To make the most of our tools, we recommend starting with the individual README
files for each tool. These documents will guide you through setup instructions, usage guidelines, and practical examples.
You can easily install crdtoapi
globally using npm:
npm install --location=global crdtoapi
Note: The --location=global
flag ensures that you install the package globally, making the tools accessible from anywhere in your terminal.
If you wish to contribute or build the project from source, follow these steps to lint, build, and publish the package:
npm install
npm run lint:fix
npm run build
npm publish