{"id":13406312,"url":"https://github.com/Redocly/redoc","last_synced_at":"2025-03-14T10:32:52.705Z","repository":{"id":37444785,"uuid":"45250726","full_name":"Redocly/redoc","owner":"Redocly","description":"📘  OpenAPI/Swagger-generated API Reference Documentation","archived":false,"fork":false,"pushed_at":"2024-04-02T15:28:38.000Z","size":56438,"stargazers_count":22428,"open_issues_count":322,"forks_count":2234,"subscribers_count":294,"default_branch":"main","last_synced_at":"2024-04-13T19:59:16.548Z","etag":null,"topics":["api-documentation","documentation-generator","documentation-tool","hacktoberfest","openapi","openapi-specification","openapi3","openapi31","reactjs","redoc","swagger"],"latest_commit_sha":null,"homepage":"https://redocly.github.io/redoc/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Redocly.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"docs/security-definitions-injection.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2015-10-30T12:53:02.000Z","updated_at":"2024-04-13T19:19:44.000Z","dependencies_parsed_at":"2023-10-23T13:26:49.269Z","dependency_job_id":"a2890045-c25d-4034-a12c-2f5df38804e1","html_url":"https://github.com/Redocly/redoc","commit_stats":{"total_commits":2522,"total_committers":225,"mean_commits":11.20888888888889,"dds":"0.23235527359238695","last_synced_commit":"3f3f9551ee36f8743a65d774f5212a34dea1affc"},"previous_names":["rebilly/redoc"],"tags_count":222,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Redocly%2Fredoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Redocly","download_url":"https://codeload.github.com/Redocly/redoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221093173,"owners_count":16754852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","documentation-generator","documentation-tool","hacktoberfest","openapi","openapi-specification","openapi3","openapi31","reactjs","redoc","swagger"],"created_at":"2024-07-30T19:02:26.888Z","updated_at":"2025-03-14T10:32:52.695Z","avatar_url":"https://github.com/Redocly.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Redoc logo\" src=\"https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png\" width=\"400px\" /\u003e\n\n# Generate beautiful API documentation from OpenAPI\n\n  [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/main/LICENSE)\n\n  [![bundle size](http://img.badgesize.io/https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js?compression=gzip\u0026max=300000)](https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js) [![npm](https://img.shields.io/npm/dm/redoc.svg)](https://www.npmjs.com/package/redoc) [![jsDelivr status](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc)\n\u003c/div\u003e\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://raw.githubusercontent.com/Redocly/redoc/main/demo/redoc-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://redocly.github.io/redoc/.\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/scrolling 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://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension\n- [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)\n- Code samples support (with vendor extension) \u003cbr\u003e\n  ![code samples in action](docs/images/code-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/cli 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\u003e [Redocly CLI](https://github.com/Redocly/redocly-cli/) 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://petstore.swagger.io/v2/swagger.json\"\u003e\u003c/redoc\u003e\n    \u003cscript src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"\u003e \u003c/script\u003e\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\u003e` 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://redocly.com/docs/redoc/deployment/html/) for more details.\n\n### More usage options\n\nCheck out the [deployment documentation](./docs/deployment/intro.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://redocly.com/docs/api-registry/guides/api-registry-quickstart/)\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://redocly.com/docs/api-reference-docs/getting-started/) - we take care of the hosting\n- [Redoc](https://redocly.com/docs/redoc/) - detailed documentation for this open source project (also in the `docs/` folder)\n- [Command-line interface to bundle your docs into a web-ready HTML file](https://redocly.com/docs/cli/commands/build-docs/)\n- API linting, bundling, and much more with open source [Redocly CLI](https://redocly.com/docs/cli)\n\n## Showcase\n\nA sample of the organizations using Redocly tools in the wild:\n\n- [Rebilly](https://api-reference.rebilly.com/)\n- [Docker Engine](https://docs.docker.com/engine/api/v1.25/)\n- [Zuora](https://www.zuora.com/developer/api-reference/)\n- [Discourse](http://docs.discourse.org)\n- [Commbox](https://www.commbox.io/api/)\n- [APIs.guru](https://apis.guru/api-doc/)\n- [BoxKnight](https://www.docs.boxknight.com/)\n- [Quaderno API](https://developers.quaderno.io/api)\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/config.md) for details.\n\n### OpenAPI specification extensions\nRedoc uses the following [specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/):\n\n* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo\n* [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for tags that refer to non-navigation properties like Pagination, Rate-Limits, etc\n* [`x-codeSamples`](docs/redoc-vendor-extensions.md#x-codeSamples) - specify operation code samples\n* [`x-badges`](docs/redoc-vendor-extensions.md#x-badges) - specify operation badges\n* [`x-examples`](docs/redoc-vendor-extensions.md#x-examples) - specify JSON example for requests\n* [`x-nullable`](docs/redoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable\n* [`x-displayName`](docs/redoc-vendor-extensions.md#x-displayname) - specify human-friendly names for the menu categories\n* [`x-tagGroups`](docs/redoc-vendor-extensions.md#x-tagGroups) - group tags by categories in the side menu\n* [`x-servers`](docs/redoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0)\n* [`x-additionalPropertiesName`](docs/redoc-vendor-extensions.md#x-additionalPropertiesName) - ability to supply a descriptive name for the additional property keys\n* [`x-summary`](docs/redoc-vendor-extensions.md#x-summary) - for Response object, use as the response button text, with description rendered under the button\n* [`x-explicitMappingOnly`](docs/redoc-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://github.com/Redocly/redoc/tree/v1.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://cdn.redoc.ly/redoc/v2.0.0/bundles/redoc.standalone.js\n- `latest` release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.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://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js\n- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js\n- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.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/CONTRIBUTING.md)\n","funding_links":[],"categories":["TypeScript","Web API Modeling \u0026 Documentation","GIF Demo","Documentation","hacktoberfest","\u003e 10K ⭐️","Examples","HarmonyOS","后端开发框架及项目","OpenAPI Utilities","reactjs","The Alternatives","Open Source Tools","API","Projects","Documentation Types"],"sub_categories":["REST","Templates","Windows Manager","管理面板","12. Redoc / Redocly (Open Source \u0026 Commercial Documentation/Portal)","Swagger","API Documentation"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRedocly%2Fredoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRedocly%2Fredoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRedocly%2Fredoc/lists"}