From 93a6b4793bce9b6739b139ce6b9577b4a7335a8b Mon Sep 17 00:00:00 2001 From: kakulisen <18813972746@163.com> Date: Tue, 11 Jun 2019 11:41:09 +0800 Subject: [PATCH 1/2] Add some new description in README Signed-off-by: kakulisen <18813972746@163.com> --- README-ZH.md | 8 +++++++- README.md | 6 ++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README-ZH.md b/README-ZH.md index 4e961f6..74e8f6c 100755 --- a/README-ZH.md +++ b/README-ZH.md @@ -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 : 文档输出路径 diff --git a/README.md b/README.md index 86558ba..fbf7e56 100755 --- a/README.md +++ b/README.md @@ -106,6 +106,12 @@ $ java -jar toolkit-cli-{version}.jar codegenerate -m ServiceComb -i swagger.ya 例：--artifact-id springmvc-example * --artifact-version. Specify the artifact version of the generated project. 例：--artifact-version 1.0.0 +* --api-package : Specify the api package of the generated project. +例：--api-package com.demo.api +* --model-package : Specify the model package of the generated project. +例：--model-package com.demo.model +* -t, --service-type : Specify microservice type of generated microservice project. optional value is provider,consumer,all +例：--service-type provider #### 3.2.2 Service contract generation document ```shell From 4884afdaf51c366e0b72cdc00bdf82713e827f8e Mon Sep 17 00:00:00 2001 From: kakulisen <18813972746@163.com> Date: Tue, 11 Jun 2019 12:09:19 +0800 Subject: [PATCH 2/2] format README Signed-off-by: kakulisen <18813972746@163.com> --- README-ZH.md | 6 +++--- README.md | 36 ++++++++++++++++++------------------ 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README-ZH.md b/README-ZH.md index 74e8f6c..c48f5f1 100755 --- a/README-ZH.md +++ b/README-ZH.md @@ -107,11 +107,11 @@ $ 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 : 指定生成项目的api package 例：--api-package com.demo.api -* --model-package : 指定生成项目的model package +* --model-package : 指定生成项目的model package 例：--model-package com.demo.model -* -t, --service-type : 指定生成的微服务项目的微服务类型。可选值为provider,consumer,all +* -t, --service-type : 指定生成的微服务项目的微服务类型。可选值为provider,consumer,all 例：--service-type provider #### 3.2.2 契约生成文档 diff --git a/README.md b/README.md index fbf7e56..12ad334 100755 --- a/README.md +++ b/README.md @@ -92,26 +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 -* --api-package : Specify the api package of the generated project. -例：--api-package com.demo.api -* --model-package : Specify the model package of the generated project. -例：--model-package com.demo.model +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 -例：--service-type provider +e.g.：--service-type provider #### 3.2.2 Service contract generation document ```shell