@nahkies/openapi-code-generator

!CI/CD

@nahkies/openapi-code-generator is a CLI tool that aims to generate high quality typescript client SDK's,
and API server scaffolding (routing, validation, serialization) from OpenAPI 3 specifications.

Currently, OpenAPI 3.0, OpenAPI 3.1,
and TypeSpec are supported an input specifications.

- Documentation
- Project Structure
- Contributing
- License

Documentation

Visit https://openapi-code-generator.nahkies.co.nz/ for detailed documentation including
quick start guides and reference material.

The documentation is built using NextJS / Nextra, and deployed using Github pages.
You can contribute to it in ./packages/documentation

Project Structure

The repository is structured as a mono repo of several npm packages that work together under ./packages:

- openapi-code-generator
- typescript-axios-runtime
- typescript-fetch-runtime
- typescript-koa-runtime

The openapi-code-generator package is the main package, whilst the others are supporting packages used at runtime by
the code output by some of the templates.

Integration test definitions live in ./integration-tests-definitions and the generated
code output to ./integration-tests

Scripts to refresh the test data live in ./scripts

Contributing

Contributing guidelines can be found in ./CONTRIBUTING.md.

An overview of the codebase architecture is available here

License

See ./LICENSE