Skip to content

Commit 6c2315a

Browse files
committed
编写md
1 parent f5e1be6 commit 6c2315a

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22
RESTdoc Project是一款提升研发效能的文档软件,集测试与文档生成于一体,快速导入应用的Http API或者RPC API来快速生成文档。
33

44
## 工作模式(Work mode)
5-
RESTdoc分为两个模块,RESTdoc-console和RESTdoc-client,您可以选择只使用RESTdoc-console模块,RESTdoc-console跟传统的showdoc其实是
6-
一样的,可以正常编写API文档和WIKI,但是如果您想简化文档的生成,可以选择在您的应用中加速RESTdoc-client的依赖,并且和RESTdoc-console
7-
建立长连接,这样子RESTdoc-console可以快速导入应用的API的文档。
5+
RESTdoc分为两个模块,RESTdoc-console和RESTdoc-client,RESTdoc-console是文档可视化工作驾驶舱,您可以只选择RESTdoc-console模块进行文档的编写,
6+
如果您想快速把应用的API同步到RESTdoc-console,并且可视化展示和测试,那么就需要RESTdoc-client来帮助您完成这个需求,只需要按照以下步骤,快速接入您的应用即可。
87

98
## 架构图(Architecture)
109
![avatar](https://restdoc.oss-cn-beijing.aliyuncs.com/struct.png)

0 commit comments

Comments
 (0)