Linter for Zalando's RESTful API Guidelines

This is a very basic linter to check whether a given Swagger specification (YAML file) complies with Zalando's RESTful API Guidelines.

Usage:

$ sudo pip3 install -U restful-api-guidelines-linter
$ restful-api-guidelines-linter my-swagger-spec.yaml -v

The following guidelines are currently checked:

• Must: Always Return JSON Objects As Top-Level Data Structures To Support Extensibility
• Must: Avoid Trailing Slashes
• Must: Do Not Use URI Versioning
• Must: Pluralize Resource Names
• Must: Property names must be snake_case (and never camelCase).
• Must: Use HTTP Methods Correctly
• Must: Use lowercase separate words with hyphens for Path Segments
• Must: Use snake_case (never camelCase) for Query Parameters

Running Unit Tests

$ sudo pip3 install -U tox
$ tox