Open source · API & Integration

OpenAPI Example Validator

Check OpenAPI examples against declared schemas and required fields.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

An example in an API description is the first thing a reader copies and the last thing anyone validates. It drifts: a field is renamed in the schema and left alone in the example, a status enum gains a value the example never had, a text/plain body is illustrated with a JSON object. None of that breaks a build, and all of it breaks whoever trusted the example.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+; inspect the source before using it on your own files.

Run the checked-in example

npm install github:edilec/openapi-example-validator#v0.1.0

Read the result

This installs the tested public GitHub source release at v0.1.0; openapi-example-validator is not published to npm.

Where this check stops

This section is the honest part of the README. These are the things the tool cannot conclude, whatever its exit code says.

Before adapting the command to your own workflow, review the accepted inputs, exit codes and safety boundaries in the README.

Compiled with AI assistance from checked-in public documentation and example scripts. Run the example and review the repository's current documentation before relying on its result.