A Flake8 plugin to enforce OpenAPI docstrings in Flask routes
Project description
flake8-flask-openapi-docstring
This Flake8 plugin will check if your Flask route's docstrings are valid OpenAPI spec.
Libraries like APISpec can generate OpenAPI spec from your Flask routes and docstrings and it's important to have present and in the correct format.
for example, this routes:
@app.route("/hello", methods=["GET"])
def hello():
return "Hello World!"
will raise an error witht his plugin because not only the docstring is missing but also the OpenAPI spec
Project details
Release 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
Close
Hashes for flake8_flask_openapi_docstring-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fb90ce27ba020c2b9712eb87e2670d9cdaba31b6f44735f76ad09fb28911f3f |
|
MD5 | 8e342a598848335122f2a57b58d2dd67 |
|
BLAKE2b-256 | 1bbdddc2ffb4b0bef445b1caedf7f49f592f1a308f9d86a23b812ec24df96764 |
Close
Hashes for flake8_flask_openapi_docstring-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f02b948c9a75d3f5964f91e216b0324098692d7ad405bf1ec3f5bd8825385801 |
|
MD5 | ca181535136b184f1ba831b10bfa2776 |
|
BLAKE2b-256 | 2a790a00013caae86ebb846c5ec7a83f64482b9a49c5778413eab16ab156bf63 |