1.0.1 • Published 5 years ago
agreed-typed v1.0.1
agreed-typed
- agreed api type definitions (types.ts)
- agreed.ts to swagger generator
install
$ npm install -g agreed-typed
usage
$ agreed-typed --help
Usage: agreed-typed [subcommand] [options]
Subcommands:
gen-swagger Generate swagger file.
Options:
--help Shows the usage and exits.
--version Shows version number and exits.
Examples:
agreed-typed gen-swagger --path ./agreed.ts
gen-swagger
$ agreed-typed gen-swagger --help
Usage: agreed-typed gen-swagger [options]
Options:
--path Agreed file path (required)
--title swagger title
--description swagger description
--version document version
--depth aggregate depth (default = 2)
--dry-run dry-run mode (outputs on stdout)
--output output filename (default schema.json)
--host swagger host (default localhost:3030)
--format file format [json|yaml] (default json)
--help show help
Examples:
agreed-typed gen-swagger --path ./agreed.ts --output schema # output file = schema.json
agreed-typed gen-swagger --path ./agreed.ts --output schema --format yaml # output file = schema.yaml
License
This project is licensed under the Apache License 2.0 License - see the LICENSE file for details
1.0.1
5 years ago
1.0.0
5 years ago
0.6.3
5 years ago
0.6.2
5 years ago
0.6.1
5 years ago
0.6.0
5 years ago
0.5.5
5 years ago
0.5.4
5 years ago
0.5.3
5 years ago
0.5.2
5 years ago
0.5.1
5 years ago
0.5.0
5 years ago
0.4.0
5 years ago
0.3.5
5 years ago
0.3.4
5 years ago
0.3.3
5 years ago
0.3.2
6 years ago
0.3.1
6 years ago
0.3.0
6 years ago
0.2.2
6 years ago
0.2.1
6 years ago
0.2.0
6 years ago
0.1.0
6 years ago
0.0.5
6 years ago
0.0.4
6 years ago
0.0.3
6 years ago
0.0.2
6 years ago
0.0.1
6 years ago