Redoc 开源项目教程
2026-01-16 09:47:43作者：曹令琨Iris
1. 项目介绍
Redoc 是一个用于从 OpenAPI（前身为 Swagger）定义中生成美观API文档的开放源码工具。它提供了一个响应式的三面板布局：左侧是导航菜单和搜索栏，中间显示文档，右侧则展示请求和响应示例。Redoc 支持 OpenAPI 3.0 和 Swagger 2.0 规范，并且可以通过一些扩展定制你的文档样式。
2. 项目快速启动
安装 Redoc CLI
首先确保你的系统安装了 Node.js，然后通过以下命令全局安装 Redoc 的命令行工具：
npm install -g @redocly/cli
生成静态 HTML 文档
如果你有一个 OpenAPI 文件（例如 openapi.yaml），可以使用以下命令快速生成文档：
npx @redocly/cli build-docs openapi.yaml
这将在当前目录下创建一个名为 redoc-static.html 的文件，可以在浏览器中打开查看。
在网页上集成 Redoc
在HTML页面中引入 Redoc 的库文件并设置 spec-url 属性指向你的 OpenAPI 定义：
<!DOCTYPE html>
<html lang="en">
<head>
<title>我的API文档</title>
</head>
<body>
<redoc spec-url="http://petstore.swagger.io/v2/swagger.json"></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>
将 spec-url 替换为你自己的 OpenAPI JSON 或 YAML 地址。
3. 应用案例和最佳实践
Redoc 被广泛应用于各种组织，包括但不限于 Rebilly, Docker Engine, Zuora, Discourse 等。最佳实践包括：
- 使用
x-logo扩展自定义你的品牌标志。 - 利用
x-tagGroups建立高级分组以优化侧边栏导航。 - 提供交互式 "Try it" 控制台以方便测试API。
- 根据 OpenAPI 定义自动生成代码样本。
4. 典型生态项目
- Redoc CLI：用于构建和打包文档的命令行工具，提供额外的 Linting 和 Bundling 功能。
- Redocly：Redoc 的商业版本，提供托管的 API 参考文档和更多高级功能。
要了解更多配置和用法，可访问 Redoc 官方文档：https://redocly.github.io/redoc/#configuration。
记得时刻更新 Redoc 版本，以获得最新的特性和改进。祝您使用愉快！
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5，旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5-w4a8GLM-5-w4a8基于混合专家架构，专为复杂系统工程与长周期智能体任务设计。支持单/多节点部署，适配Atlas 800T A3，采用w4a8量化技术，结合vLLM推理优化，高效平衡性能与精度，助力智能应用开发Jinja00
请把这个活动推给顶尖程序员😎本次活动专为懂行的顶尖程序员量身打造，聚焦AtomGit首发开源模型的实际应用与深度测评，拒绝大众化浅层体验，邀请具备扎实技术功底、开源经验或模型测评能力的顶尖开发者，深度参与模型体验、性能测评，通过发布技术帖子、提交测评报告、上传实践项目成果等形式，挖掘模型核心价值，共建AtomGit开源模型生态，彰显顶尖程序员的技术洞察力与实践能力。00
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型，它在 Kimi-K2-Base 的基础上，通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式，以及对话式与智能体范式无缝融合。Python00
MiniMax-M2.5MiniMax-M2.5开源模型，经数十万复杂环境强化训练，在代码生成、工具调用、办公自动化等经济价值任务中表现卓越。SWE-Bench Verified得分80.2%，Multi-SWE-Bench达51.3%，BrowseComp获76.3%。推理速度比M2.1快37%，与Claude Opus 4.6相当，每小时仅需0.3-1美元，成本仅为同类模型1/10-1/20，为智能应用开发提供高效经济选择。【此简介由AI生成】Python00
Qwen3.5Qwen3.5 昇腾 vLLM 部署教程。Qwen3.5 是 Qwen 系列最新的旗舰多模态模型，采用 MoE（混合专家）架构，在保持强大模型能力的同时显著降低了推理成本。00- RRing-2.5-1TRing-2.5-1T：全球首个基于混合线性注意力架构的开源万亿参数思考模型。Python00
项目优选
收起
kerneldeepin linux kernel
C
27
11
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
569
3.84 K
pytorchAscend Extension for PyTorch
Python
379
453
ops-math本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。
C++
893
676
flutter_flutter暂无简介
Dart
802
199
kernelopenEuler内核是openEuler操作系统的核心，既是系统性能与稳定性的基石，也是连接处理器、设备与服务的桥梁。
C
350
203
MindSpeed-LLM昇腾LLM分布式训练框架
Python
118
147
nop-entropyNop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
leetcode🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解
Java
68
20
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.37 K
781