API 文档生成器

把一行一个的接口定义快速转换成结构化的 Markdown 接口文档。每行按「METHOD /path - 描述」书写,支持 GET、POST、PUT、DELETE、PATCH、HEAD、OPTIONS 等方法,以 # 或 ; 开头的行视为注释。所有处理都在浏览器本地完成。

接口定义输入 等待输入

每行一个接口,格式为「METHOD /path - 描述」;描述可省略。按 Ctrl + Enter 可快速生成。输入仅在本机解析,不会上传服务器。

生成的 Markdown 文档
接口数 —
方法种类 —
文档行数 —
字符数 —
输入接口定义后点击「生成文档」,Markdown 结果将显示在这里。

每行一个接口,格式为「METHOD /path - 描述」;以 # 或 ; 开头的行视为注释。

处理规则
  • 按行解析输入,跳过空行以及以 #、; 开头的注释行。
  • 接口行匹配 ^(GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS)\s+(\/\S*)\s*(?:[-—]\s*(.*))?$。
  • 每个接口输出二级标题 ## METHOD /path,其下输出描述段落。
  • 文档以一级标题 # API 文档 开头,接口顺序与输入顺序一致。
  • 未匹配到任何接口时提示错误,不会输出空文档。
  • 生成的 Markdown 可复制或下载为 .md 文件,处理全部在本地完成。