https://github.com/aymen94/io-utils-build
https://github.com/aymen94/io-utils-build
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aymen94/io-utils-build
- Owner: aymen94
- License: eupl-1.2
- Created: 2019-07-16T22:02:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-18T19:20:24.000Z (almost 6 years ago)
- Last Synced: 2025-01-02T15:28:19.419Z (5 months ago)
- Language: HTML
- Size: 35.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Utilities and tools for the Digital Citizenship initiative
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
```
## gen-api-models
This tool generates TypeScript definitions of OpenAPI specs.
In simple terms it converts an OpenAPI spec like [this one](https://github.com/teamdigitale/digital-citizenship-functions/blob/f04666c8b7f2d4bebde19676b49b19119b03ef17/api/public_api_v1.yaml) into:
* A TypeScript [representation of the specs](https://github.com/teamdigitale/digital-citizenship-functions/blob/6798225bd725a42753b16375ce18a954a268f9b6/lib/api/public_api_v1.ts).
* An [io-ts](https://github.com/gcanti/io-ts) type definitions for [each API definition](https://github.com/teamdigitale/digital-citizenship-functions/tree/6798225bd725a42753b16375ce18a954a268f9b6/lib/api/definitions) that provides compile time types and runtime validation.
Note: the generated models requires the runtime dependency `italia-ts-commons`.
### Usage
```
$ 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
```