This package provide some tools that are used across the projects of the Digital Citizenship initiative.
To add the tools to a project:
$ yarn add -D italia-utils
This tool generates TypeScript definitions of OpenAPI specs.
In simple terms it converts an OpenAPI spec like this one into:
- A TypeScript representation of the specs.
- An io-ts type definitions for each API definition that provides compile time types and runtime validation.
Note: the generated models requires the runtime dependency italia-ts-commons.
$ gen-api-models --help
Options:
--version Show version number [boolean]
--api-spec Path to input OpenAPI spec file [string] [required]
--out-dir Output directory to store generated definition files
[string] [required]
--ts-spec-file If defined, converts the OpenAPI specs to TypeScript source
and writes it to this file [string]
--help Show help [boolean]
Example:
$ gen-api-models --api-spec ./api/public_api_v1.yaml --out-dir ./lib/api/definitions --ts-spec-file ./lib/api/public_api_v1.ts
Writing TS Specs to lib/api/public_api_v1.ts
ProblemJson -> lib/api/definitions/ProblemJson.ts
NotificationChannel -> lib/api/definitions/NotificationChannel.ts
NotificationChannelStatusValue -> lib/api/definitions/NotificationChannelStatusValue.ts
...
done