Redocly avatar

Redocly/redocly-cli

1.5k 228 20
TypeScript MIT
创建于 7 年前 最后更新 1 周前

AI 综合评分

71 B 级
代码质量
65
文档质量
74
社区健康
68
项目活跃
77
创新性
62

项目简介

Redocly CLI 提供 OpenAPI 规范检查、文档生成和 API 治理的一体化工具链。

项目摘要

【主题】

把 OpenAPI 从“能写对”变成“写得漂亮且经得起流水线考验”。

【核心分点总结】

  1. 超强校验器 — 内置完整的 OpenAPI 2/3/3.1 解析器,语法与语义双重校验,连 asper 、Arrazzo 描述也能一把梭。
  2. 百变输出 — 一键生成高颜值的 Redoc 文档、React 组件、甚至 SDK 代码片段,告别手写 Swagger UI 的苦闷。
  3. 治理即配置 — 通过 .redocly.yaml 定义规则集,把团队 API 风格指南固化为 lint 规则,CI 跑不过就别想合并。
  4. 异步协议友好 — 原生支持 AsyncAPI,多协议治理不割裂,一套工具包打天下。
  5. CI/CD 原生嵌入 — 命令行零侵入,可作为 pre-commit 或流水线插件,让 API 变更有迹可循、有票可查。

【行动指南】

  1. 当你需要把散落的 OpenAPI 文件收编成一致的契约仓库时,用它的 lint 和 bundled 合并功能。
  2. 要在每次 PR 里自动拦截错误描述或缺失示例,把它塞进 GitHub Actions 或 GitLab CI,三分钟集成。
  3. 给前端或外部合作方发布交互式文档时,用 build-docs 命令生成 Redoc 静态站,比手写 Swagger UI 省力 10 倍。

【金句总述】

API 契约不再是一张草稿纸,而是有标准、有流程、有颜值的交付物。

【故事性收尾】

过去凌晨两点被前端同事追问“这个字段到底可选吗”,现在早上刚到工位,一杯咖啡的时间,文档已自动生成,规范检查通过,PR 绿灯亮起。那原本散乱的 YAML 文件,终于像图书馆里的精装书一样被整整齐齐地摆放在书架上,只需一拉门,世界瞬间变得清晰而笃定。

相关项目推荐