API 接口文档自动生成

拯救不爱写文档的程序员。填表即可自动排版生成漂亮纯正的 Markdown API 联调说明书。

Workspace

API 接口文档自动生成

告别手写 Markdown 表格的痛苦!
通过直观的表单填写接口信息,右侧即时生成排版精美的 .md 规范接口文档。

接口信息定义

1. 基础信息

2. 请求头 (Headers)

3. URL / Query 参数

4. Request Body (JSON)

5. Response 成功响应 (JSON)

api-documentation.md

工具介绍

API 接口文档生成器 让前后端联调不再成为沟通灾难。这是一款所见即所得的极速文档编辑器,你只需要输入参数,剩下的丑陋 Markdown 表格嵌套交由代码在毫秒级内自动排版。

核心功能

深色优雅终端排版


右侧面板采用 GitHub 与 IDE 风格一致的 Markdown 直接渲染与高亮引擎引擎,告别眼花。

字段精细拆解组合


将复杂的请求体分为“Query”查询参数、“Headers”鉴权投递、以及“JSON Body”请求与反馈。一切输入都会在不打断你思路的过程中自动编排为带有规范占位说明的说明文档。

全格式剪贴板级共享


实时生成的 Markdown 文档除了可以直接下载为 .md 实体文件存放于仓库目录之外,也可以使用原生剪贴板一键将富文本直接复制到类似 GitBook、Notion 或者语雀中发布。

讨论 0

请 登录 后参与讨论

暂无评论,成为第一个分享观点的人吧。