diff --git a/docs/customization.html b/docs/customization.html index 50a483eb3db..f22f4cf101e 100644 --- a/docs/customization.html +++ b/docs/customization.html @@ -215,8 +215,11 @@ TypeScriptNodeClientCodegen.java "apiPackage" : "petstore" } +

You can use also config.yml with following equivalent example:

+
apiPackage: "petstore"
+

Supported config options can be different per language. Running config-help -g {lang} will show available options. -These options are applied via configuration file (e.g. config.json) or by passing them with -D{optionName}={optionValue}. (If -D{optionName} does not work, please open a ticket and we'll look into it)

+These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with -D{optionName}={optionValue}. (If -D{optionName} does not work, please open a ticket and we'll look into it)

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java

Output

@@ -246,6 +249,12 @@ TypeScriptNodeClientCodegen.java "library":"feign" } +

Or if you preffer yaml format it can look like

+
groupId: "com.my.company"
+artifactId: "MyClient"
+artifactVersion: "1.2.0"
+library: "feign"
+

For all the unspecified options default values will be used.

Another way to override default options is to extend the config class for the specific language. To change, for example, the prefix for the Objective-C generated files, simply subclass the ObjcClientCodegen.java:

@@ -276,4 +285,4 @@ refer back to your classes. Note, this may not apply to all languages...

or

--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder
-
Last updated on 2019-3-8
← Using TemplatesDebugging →
\ No newline at end of file +
Last updated on 2019-3-18
← Using TemplatesDebugging →
\ No newline at end of file diff --git a/docs/customization/index.html b/docs/customization/index.html index 50a483eb3db..f22f4cf101e 100644 --- a/docs/customization/index.html +++ b/docs/customization/index.html @@ -215,8 +215,11 @@ TypeScriptNodeClientCodegen.java "apiPackage" : "petstore" } +

You can use also config.yml with following equivalent example:

+
apiPackage: "petstore"
+

Supported config options can be different per language. Running config-help -g {lang} will show available options. -These options are applied via configuration file (e.g. config.json) or by passing them with -D{optionName}={optionValue}. (If -D{optionName} does not work, please open a ticket and we'll look into it)

+These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with -D{optionName}={optionValue}. (If -D{optionName} does not work, please open a ticket and we'll look into it)

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java

Output

@@ -246,6 +249,12 @@ TypeScriptNodeClientCodegen.java "library":"feign" } +

Or if you preffer yaml format it can look like

+
groupId: "com.my.company"
+artifactId: "MyClient"
+artifactVersion: "1.2.0"
+library: "feign"
+

For all the unspecified options default values will be used.

Another way to override default options is to extend the config class for the specific language. To change, for example, the prefix for the Objective-C generated files, simply subclass the ObjcClientCodegen.java:

@@ -276,4 +285,4 @@ refer back to your classes. Note, this may not apply to all languages...

or

--import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder
-
Last updated on 2019-3-8
← Using TemplatesDebugging →
\ No newline at end of file +
Last updated on 2019-3-18
← Using TemplatesDebugging →
\ No newline at end of file diff --git a/docs/usage.html b/docs/usage.html index c0a6a9049a3..07c40881881 100644 --- a/docs/usage.html +++ b/docs/usage.html @@ -448,7 +448,7 @@ SYNOPSIS 
--import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User

Configuration File

-

Rather than passing generator options in a CSV of --additional-properties, you may also provide the settings via JSON file.

+

Rather than passing generator options in a CSV of --additional-properties, you may also provide the settings via JSON file or YAML file.

For example, one of our typescript samples has the following configuration file:

{
   "npmName": "@swagger/typescript-fetch-petstore",
@@ -462,4 +462,16 @@ SYNOPSIS
 
openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
     -c config.json
 

-
Last updated on 2019-3-8
← OnlineNext →

\ No newline at end of file
+
Same configuration file can be passed into YAML format having following equivalent content:

+
npmName: "@swagger/typescript-fetch-petstore"
+npmVersion: "1.0.0"
+npmRepository: "https://skimdb.npmjs.com/registry"
+snapshot: false
+supportsES6: true
+

+
The settings are passed exactly the same as for config.json. The most important part is the file extension. Supported values are yml or yaml.
+The name of the file should be config.yml or config.yaml (in our example it will be config.yaml.

+
openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
+    -c config.yaml
+

+
Last updated on 2019-3-18
← OnlineNext →

\ No newline at end of file
diff --git a/docs/usage/index.html b/docs/usage/index.html
index c0a6a9049a3..07c40881881 100644
--- a/docs/usage/index.html
+++ b/docs/usage/index.html
@@ -448,7 +448,7 @@ SYNOPSIS
 
--import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User
 

 
Configuration File

-
Rather than passing generator options in a CSV of --additional-properties, you may also provide the settings via JSON file.

+
Rather than passing generator options in a CSV of --additional-properties, you may also provide the settings via JSON file or YAML file.

 
For example, one of our typescript samples has the following configuration file:

 
{
   "npmName": "@swagger/typescript-fetch-petstore",
@@ -462,4 +462,16 @@ SYNOPSIS
 
openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
     -c config.json
 

-
Last updated on 2019-3-8
← OnlineNext →

\ No newline at end of file
+
Same configuration file can be passed into YAML format having following equivalent content:

+
npmName: "@swagger/typescript-fetch-petstore"
+npmVersion: "1.0.0"
+npmRepository: "https://skimdb.npmjs.com/registry"
+snapshot: false
+supportsES6: true
+

+
The settings are passed exactly the same as for config.json. The most important part is the file extension. Supported values are yml or yaml.
+The name of the file should be config.yml or config.yaml (in our example it will be config.yaml.

+
openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
+    -c config.yaml
+

+
Last updated on 2019-3-18
← OnlineNext →

\ No newline at end of file