Skip to content

Pass definitions yaml as str #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Pass definitions yaml as str #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f01b4be
Updated Swagger UI
alekseyl1992 Sep 23, 2017
1184c96
Fix static urls
alekseyl1992 Sep 23, 2017
4728214
Bundle params
alekseyl1992 Sep 23, 2017
b19a002
Bundle params fix
alekseyl1992 Sep 23, 2017
d7993b1
fix method_name extraction
alekseyl1992 Dec 6, 2017
675b73a
Merge alekseyl1992/master (include SwaggerUI 3)
Jan 23, 2019
55fec70
Merge eLvErDe/support-security-definitions (Security definitions)
Jan 23, 2019
ad5a6d2
Incorrect merge, changed required for SwaggerUI 3
Jan 23, 2019
08d7a9e
Import SwaggerUI 3.20.5
Jan 23, 2019
1d089b8
Patch SwaggerUI for Python integration
Jan 23, 2019
0d6ec6f
Make unittest run with pytest
Jan 23, 2019
4251bd1
setup_swagger now accepts "definitions" kwarg containing definitions …
Feb 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions aiohttp_swagger/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ def setup_swagger(app: web.Application,
swagger_home_decor: FunctionType = None,
swagger_def_decor: FunctionType = None,
swagger_info: dict = None,
security_definitions: dict = None):
bundle_params: dict = None,
security_definitions: dict = None,
definitions: str = None):
_swagger_url = ("/{}".format(swagger_url)
if not swagger_url.startswith("/")
else swagger_url)
Expand All @@ -63,6 +65,7 @@ def setup_swagger(app: web.Application,
app, api_base_url=api_base_url, description=description,
api_version=api_version, title=title, contact=contact,
security_definitions=security_definitions,
definitions=definitions,
)
else:
swagger_info = json.dumps(swagger_info)
Expand Down Expand Up @@ -91,12 +94,12 @@ def setup_swagger(app: web.Application,
# --------------------------------------------------------------------------
app["SWAGGER_DEF_CONTENT"] = swagger_info
with open(join(STATIC_PATH, "index.html"), "r") as f:
bundle_params_str = json.dumps(bundle_params or {})
app["SWAGGER_TEMPLATE_CONTENT"] = (
f.read()
.replace("##SWAGGER_CONFIG##", '/{}{}'.
format(api_base_url.lstrip('/'), _swagger_def_url))
.replace("##STATIC_PATH##", '/{}{}'.
format(api_base_url.lstrip('/'), statics_path))
.replace("##SWAGGER_CONFIG##", _swagger_def_url)
.replace("##STATIC_PATH##", statics_path)
.replace("##BUNDLE_PARAMS##", bundle_params_str)
)


Expand Down
10 changes: 7 additions & 3 deletions aiohttp_swagger/helpers/builders.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ def _build_doc_from_func_doc(route):
end_point_doc = route.handler.__doc__.splitlines()
except AttributeError:
return {}
out.update(_extract_swagger_docs(end_point_doc))

method_name = route.method.lower()
out.update(_extract_swagger_docs(end_point_doc, method=method_name))
return out

def generate_doc_from_each_end_point(
Expand All @@ -67,7 +69,8 @@ def generate_doc_from_each_end_point(
api_version: str = "1.0.0",
title: str = "Swagger API",
contact: str = "",
security_definitions: dict = None):
security_definitions: dict = None,
definitions: str = None):
# Clean description
_start_desc = 0
for i, word in enumerate(description):
Expand Down Expand Up @@ -97,7 +100,8 @@ def nesteddict2yaml(d, indent=10, result=""):
title=title,
contact=contact,
base_path=api_base_url,
security_definitions=security_definitions)
security_definitions=security_definitions,
definitions=definitions)
)

# The Swagger OBJ
Expand Down
Loading