11 releases
0.3.3 | Apr 1, 2021 |
---|---|
0.3.2 | Mar 14, 2021 |
0.3.0 | Feb 20, 2021 |
0.2.0 | Feb 16, 2021 |
0.1.7 | Jan 27, 2021 |
#14 in #ts
30 downloads per month
33KB
784 lines
Lupinas Lullaby
Parse Swagger files (v2 and v3) into a Typescript interface file.
Help
lupinas-lullaby 0.3.2
Hanif Bin Ariffin <hanif.ariffin.4326@gmail.com>
USAGE:
lupinas-lullaby [FLAGS] [OPTIONS]
FLAGS:
-h, --help Prints help information
--skip-empty-types Skip empty types because some linter will complain.
Possibly only relevant in languages with structural typing e.g. TypeScript.
--stdin Accepts input from stdin
-V, --version Prints version information
OPTIONS:
--auth-password <auth-password> The basic authentication username payload to pass along.
--auth-user <auth-user> The basic authentication password payload to pass along.
--file <file> The Swagger file to parse.
--skip-type-name <skip-type-name>... Skip types with the given name.
Useful if the swagger file overwrites some implicitly imported classes
or its messing up type checking.
Takes multiple occurences.
--url <url> The URL to the Swagger file. Must be a URL to a JSON/YAML resource
--write <write> The destination file to write to.
If this value is not specified, it will simply write to stdout.
Example
It doesn't have the best format ... but its a perfectly valid TS file. You will prettier
this away anyways.
lupinas-lullaby on master is 📦 v0.1.3 via ⬢ v15.2.0 via 🦀 v1.49.0
❯ lupinas-lullaby --url https://petstore.swagger.io/v2/swagger.json
export type ApiResponse = {"code" ? : number;"message" ? : string;"type" ? : string;}
export type Category = {"id" ? : number;"name" ? : string;}
export type Order = {"complete" ? : boolean;"id" ? : number;"petId" ? : number;"quantity" ? : number;"shipDate" ? : Date;"status" ? : "placed" |"approved" |"delivered" ;}
export type Pet = {"category" ? : Category;"id" ? : number;"name" : string;"photoUrls" : string[];"status" ? : "available" |"pending" |"sold" ;"tags" ? : Tag[];}
export type Tag = {"id" ? : number;"name" ? : string;}
export type User = {"email" ? : string;"firstName" ? : string;"id" ? : number;"lastName" ? : string;"password" ? : string;"phone" ? : string;"userStatus" ? : number;"username" ? : string;}
Dependencies
~6–18MB
~270K SLoC