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
jiuwenclawJiuwenClaw 是一款基于openJiuwen开发的智能AI Agent，它能够将大语言模型的强大能力，通过你日常使用的各类通讯应用，直接延伸至你的指尖。Python0198- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃，整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展，旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
AtomGit城市坐标计划AtomGit 城市坐标计划开启！让开源有坐标，让城市有星火。致力于与城市合伙人共同构建并长期运营一个健康、活跃的本地开发者生态。01
awesome-zig一个关于 Zig 优秀库及资源的协作列表。Makefile00
热门内容推荐
最新内容推荐
pi-mono自定义工具开发实战指南：从入门到精通3个实时风控价值：Flink CDC+ClickHouse在金融反欺诈的实时监测指南Docling 实用指南：从核心功能到配置实践自动化票务处理系统在高并发抢票场景中的技术实现：从手动抢购痛点到智能化解决方案OpenCore Legacy Patcher显卡驱动适配指南：让老Mac焕发新生7个维度掌握Avalonia：跨平台UI框架从入门到架构师Warp框架安装部署解决方案：从环境诊断到容器化实战指南突破移动瓶颈：kkFileView的5层适配架构与全场景实战指南革新智能交互：xiaozhi-esp32如何实现百元级AI对话机器人如何打造专属AI服务器？本地部署大模型的全流程实战指南
项目优选
收起
kerneldeepin linux kernel
C
27
12
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
603
4.04 K
leetcode🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer（第 2 版）》、《程序员面试金典（第 6 版）》题解
Java
69
21
flutter_flutter暂无简介
Dart
847
204
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot，Spring Security，JWT，Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.46 K
826
nop-entropyNop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
gitea喝着茶写代码！最易用的自托管一站式代码托管平台，包含Git托管，代码审查，团队协作，软件包和CI/CD。
Go
24
0
ops-math本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。
C++
922
770
RuoYi-Cloud-Vue3🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
234
152
MindSpeed-LLM昇腾LLM分布式训练框架
Python
130
156