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
$ tox1 maintainer
Metadata
1 maintainer
Release files for restful-api-guidelines-linter 0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| restful-api-guidelines-linter-0.2.tar.gz | 5.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| restful_api_guidelines_linter-0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.5 kB
Release files / restful-api-guidelines-linter-0.2.tar.gz
| Download URL | restful-api-guidelines-linter-0.2.tar.gz |
|---|---|
| Size | 5.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
409ef746e38820a37497f09339c1a7902def9fe67d5635e7a918935b36158b02
|
|
BLAKE2b-256 checksum How to use checksums |
d951961fe5bd5665311ad81b2263efc10658cc921f2d5c6485f16409d6f384c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / restful_api_guidelines_linter-0.2-py3-none-any.whl
| Download URL | restful_api_guidelines_linter-0.2-py3-none-any.whl |
|---|---|
| Size | 7.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c76a824d564993816ba62085a3481c98d227931a5fecc727e22643eea1960748
|
|
BLAKE2b-256 checksum How to use checksums |
ad2d27c7ef71ff2d8539ba11a9a5ff72e64b0d81a06119b625710948c95405c0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for restful-api-guidelines-linter 0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
