Recommended Tools
Tools for validating, diffing, and working with generated OpenAPI specs.
Reference
Curated tools for validating, diffing, viewing, and generating clients from your openapi.json.
Validation
| Tool | Notes |
|---|---|
| IBM OpenAPI Validator | CLI linter with many Spectral-based rules aimed at production APIs. Good second check after entrest generation. |
| Spectral | Flexible rule engine; use the openapi ruleset or custom rules for your org. |
| libopenapi-validator | What entrest uses in its own tests — validates document structure and references. |
| OpenAPI Doctor | All-in-one OpenAPI toolkit from the libopenapi authors — validation, bundling, overlays, and more. |
Example with IBM OpenAPI Validator (requires Node):
npx ibm-openapi-validator path/to/openapi.jsonDiffing
| Tool | Notes |
|---|---|
| openapi-changes | Breaking-change detection with console, markdown, JSON, and HTML reports. Works across local files, git revisions, and GitHub-hosted specs. |
| oasdiff | Breaking-change detection between two spec versions. Useful in CI when the spec is generated on every build. |
| openapi-diff | Human-readable diff of paths, parameters, and schemas. |
Viewing and manual testing
The generated handler serves the spec at GET {basePath}/openapi.json and embeds Scalar at /docs by default. See API Docs for replacing or disabling the bundled UI.
printing press generates static API docs from openapi.json — offline-friendly HTML you can zip, host, or ship in a release bundle. Includes llms.txt and markdown output if you want docs aimed at agents as well as humans.
For ad-hoc requests against a running server, any OpenAPI-aware client (Postman, Bruno, Insomnia) can import openapi.json.
Client generation
Common generators that work well with entrest's component-heavy 3.0.3 specs:
- oapi-codegen (Go)
- OpenAPI Generator (many languages)
- Speakeasy (commercial, multiple languages)
Use stable operationId values and tags when picking generator options. See Best Practices.
Last updated on