RESTful API Design Linter
Checks OpenAPI paths for a leading slash and uppercase letters, and supported operations for a responses field. It does not detect verbs in paths or evaluate resource design.
About this restful api design linter
Checks OpenAPI paths for a leading slash and uppercase letters, and supported operations for a responses field. It does not detect verbs in paths or evaluate resource design Validates and converts interface schemas client-side without transmitting private endpoint specifications.
API contract & interface schema logic
Parses, validates, and transforms OpenAPI Specification (OAS) 3.0.x and 3.1.x contracts into client code, documentation, and Model Context Protocol (MCP) tool manifests. Features a path-scoped recursive dereferencing engine that expands shared $ref schema components (such as address schemas shared across billing and shipping) while reliably halting true circular loops. Validates YAML/JSON specifications against official OpenAPI metamodels with line-numbered syntax diagnostics.
Worked schema conversion scenario
Scenario: Check the implemented path and response heuristics in an OpenAPI document.
Sample input:
Processing: Report paths without a leading slash or with uppercase letters, and report supported operation objects without responses.
Illustrative output:
Schema version & syntax constraints
This is a three-rule heuristic, not a complete REST design or OpenAPI validator. It does not inspect resource semantics or live API behavior.
API specifications and schema models in RESTful API Design Linter reflect OpenAPI and JSON Schema standards. Verify generated schemas against your runtime validator.
Client-side schema processing boundary
Schema analysis and protocol mapping in RESTful API Design Linter execute locally in the browser tab without uploading endpoint definitions.
OpenAPI Specification & JSON Schema standards
OpenAPI Specification standards and JSON Schema draft definitions:
- Implementation-specific browser utility or reference guide (no single governing external standard)
RESTful API Design Linter verification · Audit standards
How to use it
- Paste an OpenAPI JSON or YAML document.
- Check path leading slash, uppercase characters, and responses on supported operations.
- Read valid and issues in JSON.
Frequently asked questions
What does REST API Design Linter examine?+
It reads paths from the supplied document, flags paths without a leading slash or with uppercase letters, and requires responses on recognized REST methods.
Can you show an input and its result?+
A GET operation under Pets with no responses produced three issues: missing slash, lowercase-kebab-case preference, and required responses.
Does a valid result guarantee a complete API design?+
No. The local checks are limited to these naming and response-presence rules; authentication, schemas, versioning, caching, status semantics, and deployment behavior are not assessed.
Which methods receive the responses check?+
The implementation checks get, post, put, patch, and delete entries. Other keys under a path are not treated as these REST operations.