无需登录 数据私有 本地保存

API Blueprint 预览器 - 在线渲染 API 文档

API 开发工具 API Blueprint 文档 渲染 预览
32
0
0
0
API Blueprint 预览器 就绪
API Blueprint 源码 行: 0
1
实时预览 等待输入

开始编写 API 文档

在左侧编辑器中输入 API Blueprint 格式的文档，
此处将实时显示渲染后的预览。

常见问题与知识点

什么是 API Blueprint？
API Blueprint 是一种基于 Markdown 的 API 描述语言，由 Apiary 创建。它允许开发者用简洁、易读的语法编写 API 文档，同时支持自动化测试、Mock 服务器生成等功能。其核心思想是"文档即规范"，一份 API Blueprint 文件既是文档也是可执行的 API 规范。
API Blueprint 与 OpenAPI (Swagger) 有什么区别？
API Blueprint 使用 Markdown 风格的语法，更注重可读性和文档优先的设计理念，适合人工编写和维护。OpenAPI 使用 JSON/YAML 格式，结构更严格，工具生态更丰富（如 Swagger UI）。两者可以相互转换，选择取决于团队偏好——如果你更看重文档的可读性和简洁性，API Blueprint 是很好的选择。
API Blueprint 的核心语法有哪些？
核心语法包括：FORMAT: 1A（版本声明）、# Group（资源组）、## Resource [/path]（资源定义）、### Action [GET]（操作定义）、+ Request（请求）、+ Response 200（响应）、+ Parameters（参数）、+ Attributes（MSON 数据模型）等。所有这些都在本工具中支持预览。
MSON 是什么？
MSON（Markdown Syntax for Object Notation）是 API Blueprint 中用于描述数据结构的语法。它允许你用缩进和 Markdown 风格的语法来描述 JSON 对象的结构、类型、是否必填、默认值等信息，比直接写 JSON 更具可读性和表达能力。
这个预览器支持哪些功能？
本工具支持实时解析和预览 API Blueprint 文档，包括：资源组识别、HTTP 方法高亮（GET/POST/PUT/DELETE/PATCH 等）、请求/响应体展示、状态码分类显示、参数表格渲染、代码块语法高亮、复制源码和导出 HTML 等功能。同时内置了 drafter.js 解析引擎用于精确解析。
如何将 API Blueprint 转换为可发布的 HTML 文档？
你可以使用本工具的"复制 HTML"按钮获取渲染后的 HTML 代码，也可以使用命令行工具如 aglio（npm install -g aglio）将 .apib 文件转换为精美的 HTML 文档。其他工具还包括 drafter（解析库）、apiary-client 等。
API Blueprint 支持哪些 HTTP 方法？
API Blueprint 支持所有标准 HTTP 方法：GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS 等。在文档中，方法用方括号标记，如 [GET] 或 [POST /users]。每个方法可以定义多个请求和响应示例，覆盖不同的状态码和场景。
这个工具的解析准确性如何？
本工具优先使用官方 drafter.js（C++ drafter 库的 WebAssembly 编译版本）进行解析，这是 Apiary 官方维护的解析器，能保证与 API Blueprint 规范的高度一致。如果 drafter.js 加载失败，工具会自动回退到内置的轻量级解析器，确保基本功能可用。
🔧 相关工具