https://github.com/mnahkies/openapi-code-generator

A code generation tool for openapi 3 / 3.1 specifications written in typescript, primarily aimed at generating typescript clients and server stubs. Other target languages may be added in future.
https://github.com/mnahkies/openapi-code-generator

angular axios devtools koa openapi openapi-generator openapi3 openapi31 typescript typespec zod

Last synced: 13 days ago
JSON representation

A code generation tool for openapi 3 / 3.1 specifications written in typescript, primarily aimed at generating typescript clients and server stubs. Other target languages may be added in future.

• Host: GitHub
• URL: https://github.com/mnahkies/openapi-code-generator
• Owner: mnahkies
• License: mit
• Created: 2020-07-27T22:27:40.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T08:12:49.000Z (6 months ago)
• Last Synced: 2024-05-21T09:30:11.477Z (6 months ago)
• Topics: angular, axios, devtools, koa, openapi, openapi-generator, openapi3, openapi31, typescript, typespec, zod
• Language: TypeScript
• Homepage: https://openapi-code-generator.nahkies.co.nz/
• Size: 13.9 MB
• Stars: 13
• Watchers: 6
• Forks: 2
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @nahkies/openapi-code-generator

![CI/CD](https://github.com/mnahkies/openapi-code-generator/actions/workflows/ci.yml/badge.svg)

[![npm](https://img.shields.io/npm/v/@nahkies/openapi-code-generator.svg)](https://www.npmjs.com/package/@nahkies/openapi-code-generator)

`@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](https://swagger.io/specification/v3), [OpenAPI 3.1](https://swagger.io/specification/),

and [TypeSpec](https://typespec.io/) are supported an input specifications.

- [Documentation](#documentation)

- [Project Structure](#project-structure)

- [Contributing](#contributing)

- [License](#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](./packages/documentation)

## Project Structure

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

- [openapi-code-generator](./packages/openapi-code-generator)

- [typescript-axios-runtime](./packages/typescript-axios-runtime)

- [typescript-fetch-runtime](./packages/typescript-fetch-runtime)

- [typescript-koa-runtime](./packages/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](./integration-tests-definitions) and the generated

code output to [./integration-tests](./integration-tests)

Scripts to refresh the test data live in [./scripts](./scripts)

## Contributing

Contributing guidelines can be found in [./CONTRIBUTING.md](./CONTRIBUTING.md).

An overview of the codebase architecture is [available here](https://openapi-code-generator.nahkies.co.nz/reference/architecture)

## License

See [./LICENSE](./LICENSE)