Core¶
flask_swag.core
module is set of simple swagger spec generation utilities.
Each dict generators are generated by marshmallow schemas in
flask_swag.schemas
and follow
swagger specification
Generation & Dumping¶
You can generate swagger root object like
from flask.ext.core import Swagger, Info
generated = Swagger(
version="2.0",
info=Info(
title="Some title.",
version="0.1.0",
),
)
And you can dump generated swagger root object like
from flask.ext.core import dump
dumped = dump(generated)
Strict Mode¶
By default, generators cannot accept unexpected fields,
but, with _strict=False
option, you can add additional fields to swagger objects
generated = Swagger(
version="2.0",
info=Info(
title="Some title.",
version="0.1.0",
),
foo='bar',
_strict=False,
)