Skip to content

Commit 33ded8e

Browse files
Updated examples
1 parent b4dcca0 commit 33ded8e

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

Readme.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Is recommended to add a script to your `package.json` or package manager that yo
3333
> Change `src/generatedApi` by your desired folder to generate the code.
3434
3535
```bash
36-
transform-swagger -f URI/TO/SWAGGER/JSON/OR/YAML -o src/generatedApi/
36+
transform-swagger -f URI/TO/SWAGGER/JSON/OR/YAML -o src/generatedApi/ -t angular2
3737
```
3838

3939
### Main CLI commands
@@ -42,17 +42,19 @@ transform-swagger -f URI/TO/SWAGGER/JSON/OR/YAML -o src/generatedApi/
4242
Usage: transform-swagger [options]
4343

4444
Options:
45-
--version Show version number [boolean]
45+
--version, -v Show version number [boolean]
4646
--clean No clean the output-folder, so old files will remain
47-
[boolean] [default: true]
48-
-f, --file Path OR URL to the swagger document to parse [required]
47+
[boolean] [default: true]
48+
-f, --file Path OR URL to the swagger document to parse
49+
[required]
4950
-o, --output-folder Specify the output folder (generated folders will be
50-
replaced) [default: "output"]
51-
-h, --help Show help [boolean]
51+
replaced) [default: "output"]
52+
-t, --template Template (preset) name or path to a template
53+
-h, --help Show help [boolean]
5254

5355
Examples:
54-
transform-swagger -f swagger.js Convert a Swagger JSON file to
55-
compatible-angular API
56+
transform-swagger -f swagger.js -o Convert a Swagger JSON file to
57+
api/ -t angular2 compatible-angular API
5658
```
5759

5860
## Development
@@ -71,6 +73,6 @@ npm run start:dev -- -f URL_TO_SWAGGER.JSON/YAML
7173
> You can re-use the downloaded file or specify another folder
7274
7375
```
74-
npm run start:dev -- -f output/temp.json
76+
npm run start:dev -- -f output/temp.json -o src/generatedApi/ -t angular2
7577
```
7678

src/services/arguments.service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export const argumentsInstance = yargs
55
.usage('Usage: $0 [options]')
66
// .command('count', 'Count the lines in a file')
77
.example(
8-
'$0 -f swagger.js',
8+
'$0 -f swagger.js -o api/ -t angular2',
99
'Convert a Swagger JSON file to compatible-angular API',
1010
)
1111
.nargs('file', 1)

0 commit comments

Comments
 (0)