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.1GLM-5.1是智谱迄今最智能的旗舰模型，也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力，在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同，它能够在一次任务中独立、持续工作超过8小时，期间自主规划、执行、自我进化，最终交付完整的工程级成果。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音（TTS）模型，代表了当前该领域的最高水平（SOTA），它直接在波形潜空间中进行操作。00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃，整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展，旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer（Mixture-of-Transformers, MoT） 架构，通过潜在令牌实现模态特异性计算，显著提升了细粒度感知能力。Jinja00
FreeSql功能强大的对象关系映射（O/RM）组件，支持 .NET Core 2.1+、.NET Framework 4.0+、Xamarin 以及 AOT。C#00
热门内容推荐
最新内容推荐
项目优选
收起
kerneldeepin linux kernel
C
27
14
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
659
4.26 K
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
pytorchAscend Extension for PyTorch
Python
503
609
kernelopenEuler内核是openEuler操作系统的核心，既是系统性能与稳定性的基石，也是连接处理器、设备与服务的桥梁。
C
391
286
flutter_flutter暂无简介
Dart
905
218
leetcode🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解
Java
69
21
MindSpeed-LLM昇腾LLM分布式训练框架
Python
142
168
ops-math本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。
C++
939
862
cherry-studio🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108