Redocly

redoc

Redocly

📘 OpenAPI/Swagger-generated API Reference Documentation

AI 简介

Redoc 是一个基于 OpenAPI(原 Swagger)定义生成美观 API 文档的开源工具。它采用响应式的三面板布局,左侧为搜索栏和导航菜单,中间展示文档内容,右侧则提供请求与响应示例。Redoc 支持 OpenAPI 3.1、3.0 以及 Swagger 2.0 标准,并允许将 API 简介集成到侧边菜单中。此外,通过使用 `x-tagGroups` 扩展,用户可以实现高级别的菜单分组;同时支持 React 应用的简单集成及代码示例功能。此工具适用于需要快速搭建高质量 API 文档页面的开发者或团队,无论是直接嵌入网页还是通过命令行生成静态文件都非常便捷。

TypeScript
MIT License
25.7k
Stars
2.4k
Forks
296
Watchers
402
Issues

Star 增长

今日+1
近 7 天+11
近 30 天+62
综合评分83.7
默认分支main