Opensource Sharing RESTdoc Project
RESTdoc Project是一款提升研发效能的文档软件,集测试与文档生成于一体,快速导入应用的Http API或者RPC API来快速生成文档。
工作模式(Work mode)
RESTdoc分为两个模块,RESTdoc-console和RESTdoc-client,RESTdoc-console是文档可视化工作驾驶舱,您可以只选择RESTdoc-console模块进行文档的编写, 如果您想快速把应用的API同步到RESTdoc-console,并且可视化展示和测试,那么就需要RESTdoc-client来帮助您完成这个需求,只需要按照以下步骤,快速接入您的应用即可。
架构图(Architecture)
快速安装RESTdoc-console
快速接入你的应用
- Maven dependency
普通web应用
<dependency>
<groupId>com.github.open-source-sharing</groupId>
<artifactId>restdoc-restweb-client</artifactId>
<version>1.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-reflect</artifactId>
<version>1.3.72</version>
</dependency>
dubbo应用
<dependency>
<groupId>com.github.open-source-sharing</groupId>
<artifactId>restdoc-dubbo-client</artifactId>
<version>1.0.RELEASE</version>
</dependency>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-reflect</artifactId>
<version>1.3.72</version>
</dependency>
- 配置application.yml/application.properties
application.yml
restdoc:
host: 127.0.0.1 # RESTdoc-console的IP地址
port: 4321 # 固定端口
application.properties
restdoc.host=127.0.0.1 # RESTdoc-console的IP地址
restdoc.port: 4321 # 固定端口
3 启动你的应用
RESTdoc-console线上体验
RESTdoc线上体验地址
登录账户:
账户:Maple
密码:Maple