agreed-typed
- agreed api type definitions (types.ts)
- agreed.ts to swagger generator
install
$ npm install -g agreed-typed
usage
$ agreed-typed --helpUsage: 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 --helpUsage: agreed-typed gen-swagger [options] Options: --path Agreed file path --title swagger title --description swagger description --version document version --depth aggregate depth --dry-run dry-run mode --output output filename --host swagger host --format file format [json|yaml] --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