No project description provided
Project description
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 -vThe following guidelines are currently checked:
Must: Always Return JSON Objects As Top-Level Data Structures To Support Extensibility
Must: Property names must be snake_case (and never camelCase).
Must: Use lowercase separate words with hyphens for Path Segments
Running Unit Tests
$ sudo pip3 install -U tox
$ toxRelease history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file restful-api-guidelines-linter-0.2.tar.gz.
File metadata
- Download URL: restful-api-guidelines-linter-0.2.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 409ef746e38820a37497f09339c1a7902def9fe67d5635e7a918935b36158b02 |
|
| MD5 | b45da60c67bd9915a614fcb2a0f6c797 |
|
| BLAKE2b-256 | d951961fe5bd5665311ad81b2263efc10658cc921f2d5c6485f16409d6f384c4 |
File details
Details for the file restful_api_guidelines_linter-0.2-py3-none-any.whl.
File metadata
- Download URL: restful_api_guidelines_linter-0.2-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c76a824d564993816ba62085a3481c98d227931a5fecc727e22643eea1960748 |
|
| MD5 | 5581f2415df1afcf4ca5752d000c38c3 |
|
| BLAKE2b-256 | ad2d27c7ef71ff2d8539ba11a9a5ff72e64b0d81a06119b625710948c95405c0 |
