About Redocly
Purpose
We've had the good fortune of working with a mix of well-respected technology companies, blue chips, and startups. We found one common thread. A good workflow yields a more productive team. A more productive team is a happier team.
Features
Write in the cloud
Use fully-featured, collaborative text editor in your browser with Reunite.
Develop documentation locally
Your documentation, your process, your way.
Tools
Redocly CLI
Open source OpenAPI multi-tool to manage, lint, validate and transform your OpenAPI files.
VSCode extension
Plug the power of OpenAPI with custom linting straight into your IDE.
Resources and learning
Museum API example
Use our example to learn about OpenAPI or try out some new tools.
Learn OpenAPI
Resources for learning more about OpenAPI and how to use it.
Learn Markdoc
Next-generation markup resources and detailed tag library.
API Guidelines builder
Use our interactive tool to build linting rules for your API.
For authors
Writing valid OpenAPI definitions is an important starting block for API reference docs. Whether you design first or code first, valid OpenAPI definitions make a big difference in the quality of the documentation. We built a highly performant tool to lint (validate), and bundle your OpenAPI definitions. If you are writing your API definitions by hand, we recommend using our split command if you have an existing definition or our openapi-starter template repository to structure your repository.
Redocly has a VS Code plugin in active development. Get faster feedback when authoring. All of our products can be managed using configuration files which you store in source control, further enhancing the docs-like-code experience.
Integrated to source control
We believe OpenAPI definitions should be stored in your source control software. We're integrated with GitHub, GitHub Enterprise, BitBucket cloud and server, Gitlab cloud and server, and Azure Repos. Each integration may work a little bit different. Throughout our docs, we'll use GitHub as our reference integration. Other integrations have specific pages explaining any differences.
You may also use other sources instead of source control, such as an API definition published at a URL or a file upload or CI/CD.
API registry
Our API registry validates and bundles your OpenAPI definitions and keeps track of them. It tracks usages and dependencies which helps automate modern cascading previews. For example, if a schema is used in three different doc projects, and a change is proposed in a pull request, Workflows will:
- Lint (validate) the OpenAPI definition.
- Bundle the OpenAPI definition as a snapshot.
- Build a preview for each project where it is used.
API docs
Three-panel interactive API reference docs generated from your OpenAPI definitions.
Modern documentation tools
Our products are crafted to enable and enhance:
- OpenAPI definition authoring, validation, and bundling
- Docs-like-code
- Single-sourcing
- Previewing or sharing previews of changes
- Automated deployments based on git ops
- Dependency and usage tracking
- Access controls on static generated content