OpenAPI Report
Validate an OpenAPI spec (JSON or YAML) and get a Markdown report — result, spec stats, and an issues table — ready to paste into a CI log or pull-request comment.
About OpenAPI Report
OpenAPI Report validates an OpenAPI spec — JSON or YAML — and returns a Markdown report covering the overall result, spec statistics, and a table of issues. It is built to paste straight into a CI log or a pull-request comment so reviewers see exactly what is wrong. Validation runs in your browser, so an unpublished API spec never has to leave your laptop.
- Category
- inspect
- Input
- Accepts: application/json, application/yaml, text/yaml or text/plain.
- Output
- Outputs: text/markdown (multiple).
- Cost
- Free, runs in your browser
- Memory
- low
Common uses
- Check an OpenAPI 3 spec for errors before merging an API-definition pull request
- Drop a validation summary into a PR comment so reviewers see issues at a glance
- Audit a hand-edited YAML spec for missing required fields and broken references
- Generate quick spec stats (path and operation counts) for a design review
- Catch a malformed schema in CI before it breaks client code generation
- Sanity-check a spec exported from a design tool before publishing it
Frequently asked questions
Does it accept both JSON and YAML?
Yes. You can paste or load the spec as JSON or YAML and it detects the format.
What does the report contain?
A pass/fail result, spec statistics, and a Markdown issues table you can paste into a CI log or PR comment.
Is my spec uploaded to a server?
No. Validation happens locally in your browser, which matters for unreleased or internal APIs.
Which OpenAPI versions are supported?
Standard OpenAPI/Swagger specs are validated; the report flags structural and schema issues it finds.
What is the output format?
Markdown (text/markdown), so it renders cleanly in GitHub, GitLab, and most CI dashboards.
Keywords
- openapi
- swagger
- report
- markdown
- validate
- ci
- api