Skip to content
This repository has been archived by the owner on Jun 21, 2019. It is now read-only.

Commit

Permalink
Merge pull request #13 from kakulisen/master
Browse files Browse the repository at this point in the history
Add some new description in README
  • Loading branch information
MabinGo committed Jun 11, 2019
2 parents 69d7396 + 4884afd commit 8c1b0f8
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
8 changes: 7 additions & 1 deletion README-ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,18 @@ $ java -jar toolkit-cli-{version}.jar codegenerate -m ServiceComb -i swagger.ya
例:--artifact-id springmvc-example
* --artifact-version : 指定生成的项目的artifact version
例:--artifact-version 1.0.0
* --api-package : 指定生成项目的api package
例:--api-package com.demo.api
* --model-package : 指定生成项目的model package
例:--model-package com.demo.model
* -t, --service-type : 指定生成的微服务项目的微服务类型。可选值为provider,consumer,all
例:--service-type provider

#### 3.2.2 契约生成文档
```shell
$ java -jar toolkit-cli-{version}.jar docgenerate -i swagger.yaml -o ./document
```
> **docGenerate** 命令选项说明:
> **docgenerate** 命令选项说明:
* -i, --input : 指定遵循OpenAPI规范的契约文件,支持yaml和json格式,支持指定本地和网络文件
例:-i http://petstore.swagger.io/v2/swagger.json
* -o, --output : 文档输出路径
Expand Down
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,20 +92,26 @@ $ java -jar toolkit-cli-{version}.jar help
$ java -jar toolkit-cli-{version}.jar codegenerate -m ServiceComb -i swagger.yaml -o ./project -p SpringMVC
```
> **codegenerate** Command option
* -m, --microservice-framework. Specify microservices framework, now supports ServiceComb.
:-m ServiceComb
* -p, --programming-model. Specify programming model, optional JAX-RS, POJO, SpringMVC, SpringBoot.
:-p SpringMvc
* -i, --input. Specifies contract files that follow the OpenAPI specification, supports yaml and json formats, and supports specifying local and network files.
:-i http://petstore.swagger.io/v2/swagger.json
* -m, --microservice-framework. Specify microservices framework, now supports ServiceComb.
e.g.:-m ServiceComb
* -p, --programming-model. Specify programming model, optional JAX-RS, POJO, SpringMVC, SpringBoot.
e.g.:-p SpringMvc
* -i, --input. Specifies contract files that follow the OpenAPI specification, supports yaml and json formats, and supports specifying local and network files.
e.g.:-i http://petstore.swagger.io/v2/swagger.json
* -o, --output. Generated project code output path.
例:-o ./project
* --group-id. Specify the group id of the generated project.
例:--group-id com.demo
* --artifact-id. Specify the artifact id of the generated project.
例:--artifact-id springmvc-example
* --artifact-version. Specify the artifact version of the generated project.
例:--artifact-version 1.0.0
e.g.:-o ./project
* --group-id. Specify the group id of the generated project.
e.g.:--group-id com.demo
* --artifact-id. Specify the artifact id of the generated project.
e.g.:--artifact-id springmvc-example
* --artifact-version. Specify the artifact version of the generated project.
e.g.:--artifact-version 1.0.0
* --api-package : Specify the api package of the generated project.
e.g.:--api-package com.demo.api
* --model-package : Specify the model package of the generated project.
e.g.:--model-package com.demo.model
* -t, --service-type : Specify microservice type of generated microservice project. optional value is provider,consumer,all
e.g.:--service-type provider

#### 3.2.2 Service contract generation document
```shell
Expand Down

0 comments on commit 8c1b0f8

Please sign in to comment.