forked from loafle/openapi-generator-original
update help generate
This commit is contained in:
parent
faef424026
commit
cf03cee58f
74
README.md
74
README.md
@ -159,18 +159,27 @@ with a number of options. You can get the options with the `help generate` comm
|
|||||||
|
|
||||||
```
|
```
|
||||||
NAME
|
NAME
|
||||||
swagger generate - Generate code with chosen lang
|
swagger-codegen-cli generate - Generate code with chosen lang
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
swagger generate [(-a <authorization> | --auth <authorization>)]
|
swagger-codegen-cli generate
|
||||||
|
[(-a <authorization> | --auth <authorization>)]
|
||||||
|
[--additional-properties <additional properties>]
|
||||||
|
[--api-package <api package>] [--artifact-id <artifact id>]
|
||||||
|
[--artifact-version <artifact version>]
|
||||||
[(-c <configuration file> | --config <configuration file>)]
|
[(-c <configuration file> | --config <configuration file>)]
|
||||||
[-D <system properties>]
|
[-D <system properties>] [--group-id <group id>]
|
||||||
(-i <spec file> | --input-spec <spec file>)
|
(-i <spec file> | --input-spec <spec file>)
|
||||||
|
[--import-mappings <import mappings>]
|
||||||
|
[--instantiation-types <instantiation types>]
|
||||||
|
[--invoker-package <invoker package>]
|
||||||
(-l <language> | --lang <language>)
|
(-l <language> | --lang <language>)
|
||||||
|
[--language-specific-primitives <language specific primitives>]
|
||||||
|
[--library <library>] [--model-package <model package>]
|
||||||
[(-o <output directory> | --output <output directory>)]
|
[(-o <output directory> | --output <output directory>)]
|
||||||
[(-t <template directory> | --template-dir <template directory>)]
|
|
||||||
[(-v | --verbose)]
|
|
||||||
[(-s | --skip-overwrite)]
|
[(-s | --skip-overwrite)]
|
||||||
|
[(-t <template directory> | --template-dir <template directory>)]
|
||||||
|
[--type-mappings <type mappings>] [(-v | --verbose)]
|
||||||
|
|
||||||
OPTIONS
|
OPTIONS
|
||||||
-a <authorization>, --auth <authorization>
|
-a <authorization>, --auth <authorization>
|
||||||
@ -178,6 +187,19 @@ OPTIONS
|
|||||||
remotely. Pass in a URL-encoded string of name:header with a comma
|
remotely. Pass in a URL-encoded string of name:header with a comma
|
||||||
separating multiple values
|
separating multiple values
|
||||||
|
|
||||||
|
--additional-properties <additional properties>
|
||||||
|
sets additional properties that can be referenced by the mustache
|
||||||
|
templates in the format of name=value,name=value
|
||||||
|
|
||||||
|
--api-package <api package>
|
||||||
|
package for generated api classes
|
||||||
|
|
||||||
|
--artifact-id <artifact id>
|
||||||
|
artifactId in generated pom.xml
|
||||||
|
|
||||||
|
--artifact-version <artifact version>
|
||||||
|
artifact version in generated pom.xml
|
||||||
|
|
||||||
-c <configuration file>, --config <configuration file>
|
-c <configuration file>, --config <configuration file>
|
||||||
Path to json configuration file. File content should be in a json
|
Path to json configuration file. File content should be in a json
|
||||||
format {"optionKey":"optionValue", "optionKey1":"optionValue1"...}
|
format {"optionKey":"optionValue", "optionKey1":"optionValue1"...}
|
||||||
@ -188,25 +210,59 @@ OPTIONS
|
|||||||
sets specified system properties in the format of
|
sets specified system properties in the format of
|
||||||
name=value,name=value
|
name=value,name=value
|
||||||
|
|
||||||
|
--group-id <group id>
|
||||||
|
groupId in generated pom.xml
|
||||||
|
|
||||||
-i <spec file>, --input-spec <spec file>
|
-i <spec file>, --input-spec <spec file>
|
||||||
location of the OpenAPI Spec, as URL or file (required)
|
location of the swagger spec, as URL or file (required)
|
||||||
|
|
||||||
|
|
||||||
|
--import-mappings <import mappings>
|
||||||
|
specifies mappings between a given class and the import that should
|
||||||
|
be used for that class in the format of type=import,type=import
|
||||||
|
|
||||||
|
--instantiation-types <instantiation types>
|
||||||
|
sets instantiation type mappings in the format of
|
||||||
|
type=instantiatedType,type=instantiatedType.For example (in Java):
|
||||||
|
array=ArrayList,map=HashMap. In other words array types will get
|
||||||
|
instantiated as ArrayList in generated code.
|
||||||
|
|
||||||
|
--invoker-package <invoker package>
|
||||||
|
root package for generated code
|
||||||
|
|
||||||
-l <language>, --lang <language>
|
-l <language>, --lang <language>
|
||||||
client language to generate (maybe class name in classpath,
|
client language to generate (maybe class name in classpath,
|
||||||
required)
|
required)
|
||||||
|
|
||||||
|
--language-specific-primitives <language specific primitives>
|
||||||
|
specifies additional language specific primitive types in the format
|
||||||
|
of type1,type2,type3,type3. For example:
|
||||||
|
String,boolean,Boolean,Double
|
||||||
|
|
||||||
|
--library <library>
|
||||||
|
library template (sub-template)
|
||||||
|
|
||||||
|
--model-package <model package>
|
||||||
|
package for generated models
|
||||||
|
|
||||||
-o <output directory>, --output <output directory>
|
-o <output directory>, --output <output directory>
|
||||||
where to write the generated files (current dir by default)
|
where to write the generated files (current dir by default)
|
||||||
|
|
||||||
|
-s, --skip-overwrite
|
||||||
|
specifies if the existing files should be overwritten during the
|
||||||
|
generation.
|
||||||
|
|
||||||
-t <template directory>, --template-dir <template directory>
|
-t <template directory>, --template-dir <template directory>
|
||||||
folder containing the template files
|
folder containing the template files
|
||||||
|
|
||||||
|
--type-mappings <type mappings>
|
||||||
|
sets mappings between swagger spec types and generated code types in
|
||||||
|
the format of swaggerType=generatedType,swaggerType=generatedType.
|
||||||
|
For example: array=List,map=Map,string=String
|
||||||
|
|
||||||
-v, --verbose
|
-v, --verbose
|
||||||
verbose mode
|
verbose mode
|
||||||
|
|
||||||
-s , --skip-overwrite
|
|
||||||
specifies if the existing files should be overwritten during
|
|
||||||
the generation
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You can then compile and run the client, as well as unit tests against it:
|
You can then compile and run the client, as well as unit tests against it:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user