可行,但需手动用Bootstrap的accordion、tab等组件结构化呈现接口信息,配合Prism.js实现JSON高亮;适合变化少的小团队内部文档,无法自动同步后端接口变更。

用 Bootstrap 4/5 直接写静态 API 文档页面可行吗?
可行,但别指望 Bootstrap 自带 API 文档功能——它不解析 OpenAPI(Swagger)规范,也不生成交互式请求面板。你得手动写 HTML 结构 + 用 Bootstrap 的accordion、tab、badge、code等组件组织内容。适合小团队快速交付内部文档,或作为 Swagger UI 的轻量替代(比如部署在没 Node 环境的静态服务器上)。
关键不是“怎么套样式”,而是怎么结构化呈现接口信息:路径、方法、请求头、参数、响应体、状态码。Bootstrap 只负责让这些信息可读、可折叠、有层次。
怎么组织一个接口区块(含请求/响应示例)?
每个接口建议用card包裹,用accordion控制请求参数、响应示例的展开收起。避免把所有字段平铺,否则页面会极长。
- 用
h5+badge标出 HTTP 方法和路径:POST/api/v1/users - 请求参数用
table(带table-sm和table-borderless),列名统一为「字段」「类型」「是否必填」「说明」 - 请求体示例用
pre>code,显式标注Content-Type: application/json - 响应示例同样用
pre>code,并在上方用badge bg-success标出200 OK,错误码另起一个accordion-item - 别忘了给 JSON 示例加
class="json"(方便后续配 Prism.js 高亮)
<div class="accordion-item">
<h2 class="accordion-header">
<button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#req-body">
请求体(JSON)
</button>
</h2>
<div id="req-body" class="accordion-collapse collapse">
<div class="accordion-body">
<small class="text-muted">Content-Type: application/json</small>
<pre class="brush:php;toolbar:false;"><code class="json">{"name": "Alice", "email": "a@example.com"}</code>
如何让 JSON 响应体自动格式化并高亮?
Bootstrap 本身不处理代码格式化。必须引入外部库,推荐Prism.js(轻量、按需加载)或highlight.js。只加载 JSON 语言包即可,不用全量引入。
- CDN 引入 Prism:
+<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>+<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script> - 确保你的
code标签有language-json类,Prism 会自动识别并格式化 - 如果发现缩进错乱,检查原始 JSON 字符串是否已用
JSON.stringify(obj, null, 2)预处理过——静态页面里不能依赖后端返回的压缩 JSON - 别用
pre嵌套code再套div,Prism 只认直接子元素是code的pre
用 Bootstrap 5 还是 4?有哪些兼容性坑?
优先选 Bootstrap 5 ——accordion、toast、offcanvas对文档导航更友好,且移除了 jQuery 依赖,后续加 JS 交互(如复制 curl 命令)更干净。但要注意几个实际问题:
-
badge类名从badge-primary变成bg-primary,旧教程代码会失效 -
data-toggle全部换成data-bs-toggle,漏改会导致折叠/标签页不工作 - 如果你用
table-responsive包接口参数表,在小屏下横向滚动条可能被card边框截断——加overflow-x: auto到card-body更稳 - 别用 Bootstrap 的
form-control写“可编辑的请求体”:静态文档不需要真实表单验证,纯展示场景用pre>code更准确、更易复制
真正难的不是布局,是怎么保持文档和后端接口定义同步。手写 HTML 没法自动校验路径是否拼错、状态码是否遗漏。一旦接口变,文档就废——所以这种方案只适合变化频率低、或有人专职维护的场景。
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











