generate 使用说明
java -jar swagger-codegen-cli.jar generate help
命令行将打出generate相关的帮助说明
NAME
swagger-codegen-cli generate - Generate code with chosen lang
SYNOPSIS
swagger-codegen-cli generate
[(-a | --auth )]
[--additional-properties ...]
[--api-package ] [--artifact-id ]
[--artifact-version ]
[(-c | --config )]
[-D ...] [--git-repo-id ]
[--git-user-id ] [--group-id ]
[--http-user-agent ]
(-i | --input-spec )
[--ignore-file-override ]
[--import-mappings ...]
[--instantiation-types ...]
[--invoker-package ]
(-l | --lang )
[--language-specific-primitives ...]
[--library ] [--model-name-prefix ]
[--model-name-suffix ]
[--model-package ]
[(-o | --output )]
[--release-note ] [--remove-operation-id-prefix]
[--reserved-words-mappings ...]
[(-s | --skip-overwrite)]
[(-t | --template-dir )]
[--type-mappings ...] [(-v | --verbose)]
OPTIONS
-a , --auth
adds authorization headers when fetching the swagger definitions
remotely. Pass in a URL-encoded string of name:header with a comma
separating multiple values
--additional-properties
sets additional properties that can be referenced by the mustache
templates in the format of name=value,name=value. You can also have
multiple occurrences of this option.
--api-package
package for generated api classes
--artifact-id
artifactId in generated pom.xml
--artifact-version
artifact version in generated pom.xml
-c , --config
Path to json configuration file. File content should be in a json
format {"optionKey":"optionValue", "optionKey1":"optionValue1"...}
Supported options can be different for each language. Run
config-help -l {lang} command for language specific config options.
-D
sets specified system properties in the format of
name=value,name=value (or multiple options, each with name=value)
--git-repo-id
Git repo ID, e.g. swagger-codegen.
--git-user-id
Git user ID, e.g. swagger-api.
--group-id
groupId in generated pom.xml
--http-user-agent
HTTP user agent, e.g. codegen_csharp_api_client, default to
'Swagger-Codegen/{packageVersion}}/{language}'
-i , --input-spec
location of the swagger spec, as URL or file (required)
--ignore-file-override
Specifies an override location for the .swagger-codegen-ignore file.
Most useful on initial generation.
--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. You
can also have multiple occurrences of this option.
--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. You can also have
multiple occurrences of this option.
--invoker-package
root package for generated code
-l , --lang
client language to generate (maybe class name in classpath,
required)
--language-specific-primitives
specifies additional language specific primitive types in the format
of type1,type2,type3,type3. For example:
String,boolean,Boolean,Double. You can also have multiple
occurrences of this option.
--library
library template (sub-template)
--model-name-prefix
Prefix that will be prepended to all model names. Default is the
empty string.
--model-name-suffix
Suffix that will be appended to all model names. Default is the
empty string.
--model-package
package for generated models
-o , --output
where to write the generated files (current dir by default)
--release-note
Release note, default to 'Minor update'.
--remove-operation-id-prefix
Remove prefix of operationId, e.g. config_getId => getId
--reserved-words-mappings
specifies how a reserved name should be escaped to. Otherwise, the
default _ is used. For example id=identifier. You can also
have multiple occurrences of this option.
-s, --skip-overwrite
specifies if the existing files should be overwritten during the
generation.
-t , --template-dir
folder containing the template files
--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. You can also have
multiple occurrences of this option.
-v, --verbose
verbose mode
讲一下我们用到的几个参数的意思
-i 表示输入的文件,editor生成的设计文件路径,如:-i d:/swagger/swagger.json
-o 代码生成目录,swagger codegen把代码生成到什么地方,如:-o d:/swagger/client
-l 生成代码语言,我们是生成java,如:-l java
-c 配置文件,配制文件路径,如:-c d:/swagger/config.json