Merge pull request #73 from Alexei-Kornienko/alex/definitions

Add possibility to provide data definitions
cr0hn · Jul 22, 2019 · 298d513 · 298d513
2 parents 664b45e + d5f8fb9
commit 298d513
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/aiohttp_swagger/__init__.py b/aiohttp_swagger/__init__.py
@@ -47,6 +47,7 @@ def setup_swagger(app: web.Application,
                   swagger_home_decor: FunctionType = None,
                   swagger_def_decor: FunctionType = None,
                   swagger_info: dict = None,
+                  definitions: dict = None,
                   security_definitions: dict = None):
     _swagger_url = ("/{}".format(swagger_url)
                     if not swagger_url.startswith("/")
@@ -62,6 +63,7 @@ def setup_swagger(app: web.Application,
             swagger_info = generate_doc_from_each_end_point(
                 app, api_base_url=api_base_url, description=description,
                 api_version=api_version, title=title, contact=contact,
+                definitions=definitions,
                 security_definitions=security_definitions,
             )
     else:

diff --git a/aiohttp_swagger/helpers/builders.py b/aiohttp_swagger/helpers/builders.py
@@ -68,6 +68,7 @@ def generate_doc_from_each_end_point(
         api_version: str = "1.0.0",
         title: str = "Swagger API",
         contact: str = "",
+        definitions: dict = None,
         security_definitions: dict = None):
     # Clean description
     _start_desc = 0
@@ -98,6 +99,7 @@ def nesteddict2yaml(d, indent=10, result=""):
                 title=title,
                 contact=contact,
                 base_path=api_base_url,
+                definitions=definitions,
                 security_definitions=security_definitions)
         )
 

diff --git a/aiohttp_swagger/templates/swagger.yaml b/aiohttp_swagger/templates/swagger.yaml
@@ -12,6 +12,10 @@ basePath: {{ base_path }}
 schemes:
   - http
   - https
+{% if definitions %}
+definitions:
+{{ definitions|nesteddict2yaml }}
+{% endif %}
 {% if security_definitions %}
 securityDefinitions:
 {{ security_definitions|nesteddict2yaml }}