https://github.com/marsxuefeng/rest-doc
RESTdoc Project is a document software that improves research and development efficiency. It integrates testing and document generation. It can quickly import the application's Http API or RPC API to quickly generate documents.
https://github.com/marsxuefeng/rest-doc
api apidoc dubbo kotlin rpc springcloud swagger tcp
Last synced: 7 days ago
JSON representation
RESTdoc Project is a document software that improves research and development efficiency. It integrates testing and document generation. It can quickly import the application's Http API or RPC API to quickly generate documents.
- Host: GitHub
- URL: https://github.com/marsxuefeng/rest-doc
- Owner: marsxuefeng
- License: apache-2.0
- Created: 2020-07-29T00:04:56.000Z (almost 6 years ago)
- Default Branch: master-2.R
- Last Pushed: 2022-11-16T01:34:40.000Z (over 3 years ago)
- Last Synced: 2026-02-05T11:47:47.531Z (5 months ago)
- Topics: api, apidoc, dubbo, kotlin, rpc, springcloud, swagger, tcp
- Language: Kotlin
- Homepage:
- Size: 7 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RESTdoc Project
RESTdoc Project是一款提升研发效能的API文档工具，无代码侵入，测试用例代码自动生成。
## 开发背景(Development Background)
- API多端对接问题多，增加调试时间成本；
- 编写文档时间成本较高；
- 传统的API文档工具(swagger)对代码有一定的侵入性。
## 工作模式(Work Mode)
RESTdoc分为两个模块，console和client， console是文档可视化工作驾驶舱，您可以只选择console模块进行文档的编写，
如果您想快速把应用的API同步到console，并且可视化展示和测试，那么就需要client来帮助您完成这个需求，只需要按照以下步骤，快速接入您的应用即可。
## 架构图(Architecture)
## 快速开始(Quick Start)
- [安装Console](#安装Console)；
- [增加maven依赖](#增加maven依赖)。
## 安装Console
- [docker-compose一键安装(推荐)](https://github.com/Open-source-sharing/REST-doc/blob/master/docker-compose-install.md "docker-compose一键安装")
- [源码安装](https://github.com/Open-source-sharing/REST-doc/blob/master/source-install.md "源码安装")
## 增加maven依赖
- Maven dependency
普通web应用
```
com.github.open-source-sharing
restdoc-restweb-client
1.0.RELEASE
org.jetbrains.kotlin
kotlin-reflect
1.3.72
```
dubbo应用
```
com.github.open-source-sharing
restdoc-dubbo-client
1.0.RELEASE
org.jetbrains.kotlin
kotlin-reflect
1.3.72
```
- 配置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 # 固定端口
```