{"id":50876416,"url":"https://github.com/marsxuefeng/rest-doc","last_synced_at":"2026-06-15T10:02:15.961Z","repository":{"id":45042577,"uuid":"283354797","full_name":"marsxuefeng/rest-doc","owner":"marsxuefeng","description":"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.","archived":false,"fork":false,"pushed_at":"2022-11-16T01:34:40.000Z","size":7337,"stargazers_count":2,"open_issues_count":13,"forks_count":0,"subscribers_count":0,"default_branch":"master-2.R","last_synced_at":"2026-02-05T11:47:47.531Z","etag":null,"topics":["api","apidoc","dubbo","kotlin","rpc","springcloud","swagger","tcp"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marsxuefeng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-29T00:04:56.000Z","updated_at":"2021-12-25T13:15:34.000Z","dependencies_parsed_at":"2023-01-23T02:30:38.989Z","dependency_job_id":null,"html_url":"https://github.com/marsxuefeng/rest-doc","commit_stats":null,"previous_names":["marsxuefeng/rest-doc"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/marsxuefeng/rest-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marsxuefeng%2Frest-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marsxuefeng%2Frest-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marsxuefeng%2Frest-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marsxuefeng%2Frest-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marsxuefeng","download_url":"https://codeload.github.com/marsxuefeng/rest-doc/tar.gz/refs/heads/master-2.R","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marsxuefeng%2Frest-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34357282,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","apidoc","dubbo","kotlin","rpc","springcloud","swagger","tcp"],"created_at":"2026-06-15T10:02:15.324Z","updated_at":"2026-06-15T10:02:15.957Z","avatar_url":"https://github.com/marsxuefeng.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RESTdoc Project\nRESTdoc Project是一款提升研发效能的API文档工具，无代码侵入，测试用例代码自动生成。\n\n## 开发背景(Development Background)\n- API多端对接问题多，增加调试时间成本；\n- 编写文档时间成本较高；\n- 传统的API文档工具(swagger)对代码有一定的侵入性。\n\n## 工作模式(Work Mode)\nRESTdoc分为两个模块，console和client， console是文档可视化工作驾驶舱，您可以只选择console模块进行文档的编写，\n如果您想快速把应用的API同步到console，并且可视化展示和测试，那么就需要client来帮助您完成这个需求，只需要按照以下步骤，快速接入您的应用即可。\n\n## 架构图(Architecture)\n![avatar](https://restdoc.oss-cn-beijing.aliyuncs.com/struct.png)\n\n## 快速开始(Quick Start)\n-  [安装Console](#安装Console)；\n-  [增加maven依赖](#增加maven依赖)。\n\n## 安装Console\n\n- [docker-compose一键安装(推荐)](https://github.com/Open-source-sharing/REST-doc/blob/master/docker-compose-install.md \"docker-compose一键安装\")\n- [源码安装](https://github.com/Open-source-sharing/REST-doc/blob/master/source-install.md \"源码安装\")\n\n\n## 增加maven依赖\n\n- Maven dependency \u003cbr\u003e\n\n普通web应用\n\n```\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.open-source-sharing\u003c/groupId\u003e\n  \u003cartifactId\u003erestdoc-restweb-client\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.RELEASE\u003c/version\u003e\n\u003c/dependency\u003e\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.jetbrains.kotlin\u003c/groupId\u003e\n  \u003cartifactId\u003ekotlin-reflect\u003c/artifactId\u003e\n  \u003cversion\u003e1.3.72\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\ndubbo应用\n```\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.open-source-sharing\u003c/groupId\u003e\n  \u003cartifactId\u003erestdoc-dubbo-client\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.RELEASE\u003c/version\u003e\n\u003c/dependency\u003e\n\u003cdependency\u003e\n  \u003cgroupId\u003eorg.jetbrains.kotlin\u003c/groupId\u003e\n  \u003cartifactId\u003ekotlin-reflect\u003c/artifactId\u003e\n  \u003cversion\u003e1.3.72\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n\n- 配置application.yml/application.properties\n\napplication.yml\n```\nrestdoc:\n  host: 127.0.0.1  # RESTdoc-console的IP地址\n  port: 4321   # 固定端口\n```\n\napplication.properties\n```\nrestdoc.host=127.0.0.1  # RESTdoc-console的IP地址\nrestdoc.port: 4321   # 固定端口\n```\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarsxuefeng%2Frest-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarsxuefeng%2Frest-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarsxuefeng%2Frest-doc/lists"}