lune-climate
Lune openapi typescript generator
This repo is a friendly fork of the excellent https://github.com/ferdikoomen/openapi-typescript-codegen. The fork contains several changes to the generator to better fit our exact use case. Some of these changes we'll try to get merged into the upstream, but some are more of a specific use case for us, hence the need for a fork. This code is used by https://github.com/lune-climate/lune-ts to generate the base models/services.
We have some Developer documentation.
Release process
Changes made to the library will only be picked up by lune-ts once a new version is released to npm.
The release process consists of:
- Manually up the version as desired (major, minor, patch) on
package-lock.jsonandpackage.json. - Create a PR with the changes.
- Get the PR approved and merged as usual.
- After the changes are in master, create a new release on GH with the corresponding tag.
After the GH release is created, the library will be automatically released to npm.
OpenAPI Typescript Codegen
Node.js library that generates Typescript clients based on the OpenAPI specification.
Why?
- Frontend ❤️ OpenAPI, but we do not want to use JAVA codegen in our builds
- Quick, lightweight, robust and framework-agnostic 🚀
- Supports generation of TypeScript clients
- Supports generations of Fetch, Node-Fetch, Axios, Angular and XHR http clients
- Supports OpenAPI specification v2.0 and v3.0
- Supports JSON and YAML files for input
- Supports generation through CLI, Node.js and NPX
- Supports tsc and @babel/plugin-transform-typescript
- Supports aborting of requests (cancelable promise pattern)
- Supports external references using json-schema-ref-parser
Install
npm install openapi-typescript-codegen --save-devUsage
$ openapi --help
Usage: openapi [options]
Options:
-V, --version output the version number
-i, --input <value> OpenAPI specification, can be a path, url or string content (required)
-o, --output <value> Output directory (required)
-v, --apiVersion <value> API calendar version value, added as `Lune-Version` header to all requests (required)
-c, --client <value> HTTP client to generate [fetch, xhr, node, axios, angular] (default: "fetch")
--name <value> Custom client class name
--useOptions Use options instead of arguments
--useUnionTypes Use union types instead of enums
--exportCore <value> Write core files to disk (default: true)
--exportServices <value> Write services to disk (default: true)
--exportModels <value> Write models to disk (default: true)
--exportSchemas <value> Write schemas to disk (default: false)
--indent <value> Indentation options [4, 2, tab] (default: "4")
--postfix <value> Service name postfix (default: "Service")
--request <value> Path to custom request file
-h, --help display help for command
Examples
$ openapi --input ./spec.json --output ./generated --apiVersion '2024-08-08'
$ openapi --input ./spec.json --output ./generated --apiVersion '2024-08-08' --client xhrDocumentation
For end-users:
- Basic usage
- OpenAPI object
- Client instances
--name - Argument vs. Object style
--useOptions - Enums vs. Union types
--useUnionTypes - Runtime schemas
--exportSchemas - Enum with custom names and descriptions
- Nullable props (OpenAPI v2)
- Authorization
- External references
For developers: