You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2019/06/21 07:09:34 UTC
[servicecomb-toolkit] 18/49: Add todo list
This is an automated email from the ASF dual-hosted git repository.
ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-toolkit.git
commit 5db906488ddccff20702f3ff977196ac3e7a9aa5
Author: MabinGo <bi...@huawei.com>
AuthorDate: Sat May 25 19:45:37 2019 +0800
Add todo list
Signed-off-by: MabinGo <bi...@huawei.com>
---
README.md | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 7b4a73d..b140cc9 100755
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
* 快速构建基于流行微服务框架和编程模型的微服务工程,并提供服务契约、代码、文档的一体化制作能力,帮助基于服务契约开发的用户在微服务转型阶段,降低微服务入门成本,聚焦业务开发,提升遗留系统重构、开发效率。
-### 1.2 功能
+### 1.2 特性
* 代码提取服务契约
@@ -26,6 +26,18 @@
输入符合OpenAPI规范的服务契约,一键生成html/word/pdf格式的文档。
+* Todo List
+
+ * 支持契约一键制作以SpringCloud等流行微服务框架为底座的微服务工程。
+
+ * 支持基于gradle的契约开发插件。
+
+ * 支持插件埋入eclipse。
+
+ * 支持word、pdf等流行格式文档。
+
+ * 支持契约增量生成代码。
+
### 1.3 适用场景
* 集成多厂商应用的企业
@@ -132,7 +144,7 @@ mvn toolkit:generateContracts
配置项
* outputDir : 生成的契约文件输出路径,默认contracts
例:
-```shell
+```xml
<outputDir>contracts</outputDir>
```
@@ -148,7 +160,7 @@ mvn toolkit:generateDoc
* docOutputDir : 生成的契约文档输出路径,默认build/doc
例:
-```shell
+```xml
<outputDir>contracts</outputDir>
<docOutputDir>build/doc</docOutputDir>
```