Open Source Windows Documentation Software

Vizualize API changes to improve the quality of reviews. Test API changes to ensure nothing bad slips through. OpenAPI diffs are difficult to read. Because these files contain references, small changes can have a large effect on your API. Linters can not check for backward compatibility or enforce versioning and deprecation policies. Optic adds a visual changelog to every Pull Request that makes it easy to see exactly what API changes have been proposed. Optic tests each set of API changes in CI, making it more powerful than a linter. Our built-in checks will help any team ship a more reliable API. OpenAPI diffs are very difficult to review, comprehend and give feedback on. Optic’s changelogs are easy to understand allowing anyone (even non-developers) to participate in review. Optic goes beyond linting OpenAPI, it lets you write test about each set of API changes. We also make it easy to share your API standards.