[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-3639":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":20,"compositeScore":21,"rankGlobal":10,"rankLanguage":10,"license":22,"archived":23,"fork":23,"defaultBranch":24,"hasWiki":23,"hasPages":25,"topics":26,"createdAt":10,"pushedAt":10,"updatedAt":37,"readmeContent":38,"aiSummary":39,"trendingCount":16,"starSnapshotCount":16,"syncStatus":40,"lastSyncTime":41,"discoverSource":42},3639,"redoc","Redocly\u002Fredoc","Redocly","📘  OpenAPI\u002FSwagger-generated API Reference Documentation","https:\u002F\u002Fredocly.github.io\u002Fredoc\u002F",null,"TypeScript",25741,2385,296,402,0,1,11,63,9,45,"MIT License",false,"main",true,[27,28,29,30,31,32,33,34,35,5,36],"api-documentation","documentation-generator","documentation-tool","hacktoberfest","openapi","openapi-specification","openapi3","openapi31","reactjs","swagger","2026-06-12 02:00:52","\u003Cdiv align=\"center\">\n  \u003Cimg alt=\"Redoc logo\" src=\"https:\u002F\u002Fraw.githubusercontent.com\u002FRedocly\u002Fredoc\u002Fmain\u002F\u002Fdocs\u002Fimages\u002Fredoc.png\" width=\"400px\" \u002F>\n\n# Generate beautiful API documentation from OpenAPI\n\n  [![npm](http:\u002F\u002Fimg.shields.io\u002Fnpm\u002Fv\u002Fredoc.svg)](https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fredoc) [![License](https:\u002F\u002Fimg.shields.io\u002Fnpm\u002Fl\u002Fredoc.svg)](https:\u002F\u002Fgithub.com\u002FRedocly\u002Fredoc\u002Fblob\u002Fmain\u002FLICENSE)\n\n  [![bundle size](http:\u002F\u002Fimg.badgesize.io\u002Fhttps:\u002F\u002Fcdn.redoc.ly\u002Fredoc\u002Flatest\u002Fbundles\u002Fredoc.standalone.js?compression=gzip&max=300000)](https:\u002F\u002Fcdn.redoc.ly\u002Fredoc\u002Flatest\u002Fbundles\u002Fredoc.standalone.js) [![npm](https:\u002F\u002Fimg.shields.io\u002Fnpm\u002Fdm\u002Fredoc.svg)](https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fredoc) [![jsDelivr status](https:\u002F\u002Fdata.jsdelivr.com\u002Fv1\u002Fpackage\u002Fnpm\u002Fredoc\u002Fbadge)](https:\u002F\u002Fwww.jsdelivr.com\u002Fpackage\u002Fnpm\u002Fredoc)\n\u003C\u002Fdiv>\n\n\n## About Redoc\n\nRedoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions.\n\nBy default Redoc offers a three-panel, responsive layout:\n\n- The left panel contains a search bar and navigation menu.\n- The central panel contains the documentation.\n- The right panel contains request and response examples.\n\n![Redoc demo](https:\u002F\u002Fraw.githubusercontent.com\u002FRedocly\u002Fredoc\u002Fmain\u002Fdemo\u002Fredoc-demo.png)\n\n## Live demo\n\nIf you want to see how Redoc renders your OpenAPI definition,\nyou can try it out online at https:\u002F\u002Fredocly.github.io\u002Fredoc\u002F.\n\nA version of the Swagger Petstore API is displayed by default.\nTo test it with your own OpenAPI definition,\nenter the URL for your definition and select **TRY IT**.\n\n## Redoc features\n\n- Responsive three-panel design with menu\u002Fscrolling synchronization\n- Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0\n- Ability to integrate your API introduction into the side menu\n- High-level grouping in side menu with the [`x-tagGroups`](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fapi-reference-docs\u002Fspecification-extensions\u002Fx-tag-groups\u002F) specification extension\n- [Simple integration with `create-react-app`](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fredoc\u002Fquickstart\u002Freact\u002F)\n- Code samples support (with vendor extension) \u003Cbr>\n  ![code samples in action](docs\u002Fimages\u002Fcode-samples-demo.gif)\n\n## Usage\n\nRedoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component.\n\n### Generate documentation from the CLI\n\nIf you have Node installed, quickly generate documentation using `npx`:\n\n```bash\nnpx @redocly\u002Fcli build-docs openapi.yaml\n```\n\nThe tool outputs by default to a file named `redoc-static.html` that you can open in your browser.\n\n> [Redocly CLI](https:\u002F\u002Fgithub.com\u002FRedocly\u002Fredocly-cli\u002F) does more than docs; check it out and add linting, bundling, and more to your API workflow.\n\n### Add an HTML element to the page\n\nCreate an HTML page, or edit an existing one, and add the following within the body tags:\n\n```html\n    \u003Credoc spec-url=\"http:\u002F\u002Fpetstore.swagger.io\u002Fv2\u002Fswagger.json\">\u003C\u002Fredoc>\n    \u003Cscript src=\"https:\u002F\u002Fcdn.redoc.ly\u002Fredoc\u002Flatest\u002Fbundles\u002Fredoc.standalone.js\"> \u003C\u002Fscript>\n```\n\nOpen the HTML file in your browser, and your API documentation is shown on the page.\n\nAdd your own `spec-url` to the `\u003Credoc>` tag; this attribute can also be a local file. The JavaScript library can also be installed locally using `npm` and served from your own server, see the [HTML deployment documentation](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fredoc\u002Fdeployment\u002Fhtml\u002F) for more details.\n\n### More usage options\n\nCheck out the [deployment documentation](.\u002Fdocs\u002Fdeployment\u002Fintro.md) for more options, and detailed documentation for each.\n\n## Redoc vs. Redocly API Reference\n\nRedoc is Redocly's community-edition product. Looking for something more?\nWe also offer [hosted API reference documentation](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fapi-registry\u002Fguides\u002Fapi-registry-quickstart\u002F)\nwith additional features including:\n\n* Try-it console\n* Automated code samples\n* Pagination\n* Extra theme options\n\n### Documentation and resources\n\n- [Reference docs](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fapi-reference-docs\u002Fgetting-started\u002F) - we take care of the hosting\n- [Redoc](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fredoc\u002F) - detailed documentation for this open source project (also in the `docs\u002F` folder)\n- [Command-line interface to bundle your docs into a web-ready HTML file](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fcli\u002Fcommands\u002Fbuild-docs\u002F)\n- API linting, bundling, and much more with open source [Redocly CLI](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fcli)\n\n## Showcase\n\nA sample of the organizations using Redocly tools in the wild:\n\n- [Rebilly](https:\u002F\u002Fapi-reference.rebilly.com\u002F)\n- [Docker Engine](https:\u002F\u002Fdocs.docker.com\u002Fengine\u002Fapi\u002Fv1.25\u002F)\n- [Zuora](https:\u002F\u002Fwww.zuora.com\u002Fdeveloper\u002Fapi-reference\u002F)\n- [Discourse](http:\u002F\u002Fdocs.discourse.org)\n- [Commbox](https:\u002F\u002Fwww.commbox.io\u002Fapi\u002F)\n- [APIs.guru](https:\u002F\u002Fapis.guru\u002Fapi-doc\u002F)\n- [BoxKnight](https:\u002F\u002Fwww.docs.boxknight.com\u002F)\n- [Quaderno API](https:\u002F\u002Fdevelopers.quaderno.io\u002Fapi)\n\n_Pull requests to add your own API page to the list are welcome_\n\n## Configuration\n\nRedoc is highly configurable, see the [configuration documentation](docs\u002Fconfig.md) for details.\n\n### OpenAPI specification extensions\nRedoc uses the following [specification extensions](https:\u002F\u002Fredocly.com\u002Fdocs\u002Fapi-reference-docs\u002Fspec-extensions\u002F):\n\n* [`x-logo`](docs\u002Fredoc-vendor-extensions.md#x-logo) - is used to specify API logo\n* [`x-traitTag`](docs\u002Fredoc-vendor-extensions.md#x-traitTag) - useful for tags that refer to non-navigation properties like Pagination, Rate-Limits, etc\n* [`x-codeSamples`](docs\u002Fredoc-vendor-extensions.md#x-codeSamples) - specify operation code samples\n* [`x-badges`](docs\u002Fredoc-vendor-extensions.md#x-badges) - specify operation badges\n* [`x-examples`](docs\u002Fredoc-vendor-extensions.md#x-examples) - specify JSON example for requests\n* [`x-nullable`](docs\u002Fredoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable\n* [`x-displayName`](docs\u002Fredoc-vendor-extensions.md#x-displayname) - specify human-friendly names for the menu categories\n* [`x-tagGroups`](docs\u002Fredoc-vendor-extensions.md#x-tagGroups) - group tags by categories in the side menu\n* [`x-servers`](docs\u002Fredoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0)\n* [`x-additionalPropertiesName`](docs\u002Fredoc-vendor-extensions.md#x-additionalPropertiesName) - ability to supply a descriptive name for the additional property keys\n* [`x-summary`](docs\u002Fredoc-vendor-extensions.md#x-summary) - for Response object, use as the response button text, with description rendered under the button\n* [`x-explicitMappingOnly`](docs\u002Fredoc-vendor-extensions.md#x-explicitMappingOnly) - in Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object\n\n## Releases\n\n**The README for the `1.x` version is on the [v1.x](https:\u002F\u002Fgithub.com\u002FRedocly\u002Fredoc\u002Ftree\u002Fv1.x) branch.**\n\nAll the 2.x releases are deployed to npm and can be used with Redocly-cdn:\n- particular release, for example, `v2.0.0`: https:\u002F\u002Fcdn.redoc.ly\u002Fredoc\u002Fv2.0.0\u002Fbundles\u002Fredoc.standalone.js\n- `latest` release: https:\u002F\u002Fcdn.redoc.ly\u002Fredoc\u002Flatest\u002Fbundles\u002Fredoc.standalone.js\n\nAdditionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:\n- particular release, for example `v1.2.0`: https:\u002F\u002Frebilly.github.io\u002FReDoc\u002Freleases\u002Fv1.2.0\u002Fredoc.min.js\n- `v1.x.x` release: https:\u002F\u002Frebilly.github.io\u002FReDoc\u002Freleases\u002Fv1.x.x\u002Fredoc.min.js\n- `latest` release: https:\u002F\u002Frebilly.github.io\u002FReDoc\u002Freleases\u002Flatest\u002Fredoc.min.js - points to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.\n\n\n## Development\nsee [CONTRIBUTING.md](.github\u002FCONTRIBUTING.md)\n","Redoc 是一个基于 OpenAPI（原 Swagger）定义生成美观 API 文档的开源工具。它采用响应式的三面板布局，左侧为搜索栏和导航菜单，中间展示文档内容，右侧则提供请求与响应示例。Redoc 支持 OpenAPI 3.1、3.0 以及 Swagger 2.0 标准，并允许将 API 简介集成到侧边菜单中。此外，通过使用 `x-tagGroups` 扩展，用户可以实现高级别的菜单分组；同时支持 React 应用的简单集成及代码示例功能。此工具适用于需要快速搭建高质量 API 文档页面的开发者或团队，无论是直接嵌入网页还是通过命令行生成静态文件都非常便捷。",2,"2026-06-11 02:55:10","top_language"]