Skip to content

Commit 8224c18

Browse files
committed
Update README.md
1 parent bd9958b commit 8224c18

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,32 @@ Npm installs the binaries as both `raml-toolkit` and `ramlint` and they can be u
3434

3535
### Commands for OAS
3636

37+
- [`raml-toolkit generate`](#raml-toolkit-generate)
3738
- [`raml-toolkit diff BASE NEW -s oas`](#raml-toolkit-diff-base-new-s-oas)
3839
- [`raml-toolkit download`](#raml-toolkit-download)
3940

41+
#### `raml-toolkit generate`
42+
43+
A wrapper command for `openapi-generator-cli generate`
44+
45+
USAGE
46+
$ raml-toolkit generate -i OAS_spec_file -o output_dir -t templates_dir
47+
48+
OPTIONS
49+
-i, --inputSpec=OAS_spec_file Format of the output. Defaults to JSON if --out-file is specified,
50+
otherwise text.
51+
52+
-o, --outputDir=output_dir The directory to place the generated API
53+
54+
-t, --templateDir=template_dir The directory with the mustache templates for generating the API
55+
56+
-c, --configFile=config_file A yaml file containing configurations for openapi-generator-cli. A default configuration will be used if this is not provided.
57+
58+
-g, --generator The generator. Defaults to `typescript-fetch`
59+
60+
--skipValidateSpec Generate API without validating the spec. Defaults to false.
61+
62+
4063
#### `raml-toolkit diff BASE NEW -s oas`
4164

4265
**Note:** This command requires that oasdiff is. installed. Install oasdiff according to https://github.com/oasdiff/oasdiff#installation

0 commit comments

Comments
 (0)