Support openapi3 refs (#39)

Author: katerinatiddy

src/flask_openapi/base.py

@@ -7,19 +7,27 @@
 
 """
 import codecs
+import json
 import logging
 import os
 import re
-from typing import Optional
-
-import yaml
-import json
-
 from collections import defaultdict
 from functools import partial, wraps
+from typing import Optional
 
-from flask import (abort, Blueprint, current_app, jsonify, Markup, redirect,
-                   render_template, request, Response, url_for)
+import yaml
+from flask import (
+    abort,
+    Blueprint,
+    current_app,
+    jsonify,
+    Markup,
+    redirect,
+    render_template,
+    request,
+    Response,
+    url_for,
+)
 from flask.json import JSONEncoder
 from flask.views import MethodView
 from werkzeug.datastructures import Authorization
@@ -32,12 +40,21 @@
 from mistune import markdown
 
 from . import __version__
-from .constants import (OAS3_SUB_COMPONENTS, OPTIONAL_FIELDS,
-                        OPTIONAL_OAS3_FIELDS)
-from .utils import (extract_definitions, extract_schema, get_schema_specs,
-                    get_specs, get_vendor_extension_fields, is_openapi3,
-                    LazyString, parse_definition_docstring, parse_imports,
-                    swag_annotation, validate)
+from .constants import OAS3_SUB_COMPONENTS, OPTIONAL_FIELDS, OPTIONAL_OAS3_FIELDS
+from .utils import (
+    convert_responses_to_openapi3,
+    extract_definitions,
+    extract_schema,
+    get_schema_specs,
+    get_specs,
+    get_vendor_extension_fields,
+    is_openapi3,
+    LazyString,
+    parse_definition_docstring,
+    parse_imports,
+    swag_annotation,
+    validate,
+)
 
 
 def NO_SANITIZER(text):
@@ -546,20 +563,29 @@ def get_operations(swag, path_verb=None):
                 operation['requestBody'] = request_body
             if callbacks:
                 operation['callbacks'] = callbacks
-            if responses:
-                operation['responses'] = responses
             # parameters - swagger ui dislikes empty parameter lists
             if len(params) > 0:
                 operation['parameters'] = params
+
+            media_types = ['application/json']
             # other optionals
             for key in optional_fields:
                 if key in swag:
                     value = swag.get(key)
                     if key in ('produces', 'consumes'):
                         if not isinstance(value, (list, tuple)):
                             value = [value]
+                        if key == 'produces':
+                            media_types = value
 
                     operation[key] = value
+
+                if responses:
+                    if is_openapi3(openapi_version):
+                        convert_responses_to_openapi3(responses, media_types)
+
+                    operation['responses'] = responses
+
             if path_verb:
                 operations[path_verb] = operation
             else:
@@ -616,8 +642,12 @@ def get_operations(swag, path_verb=None):
                         paths[srule][key] = val
         self.apispecs[endpoint] = data
 
+        # if is_openapi3(openapi_version):
+        #     del data['definitions']
         if is_openapi3(openapi_version):
-            del data['definitions']
+            # Copy definitions to components/schemas
+            if definitions:
+                data.setdefault('components', {}).setdefault('schemas', {}).update(definitions)
 
         return data
 
@@ -786,7 +816,7 @@ def update_schemas_parsers(self, doc, schemas, parsers, definitions):
         '''
         Schemas and parsers would be updated here from doc
         '''
-        if self.is_openapi3():
+        if is_openapi3(self.config.get('openapi')):
             # 'json' to comply with self.SCHEMA_LOCATIONS's {'body':'json'}
             location = 'json'
             json_schema = None

src/flask_openapi/utils.py

@@ -11,7 +11,6 @@
 from collections import defaultdict, OrderedDict
 from copy import deepcopy
 from functools import wraps
-from importlib import import_module
 
 import jsonschema
 import yaml
@@ -1070,3 +1069,26 @@ def get_swag_path_from_doc_dir(method: any, view_class: any, doc_dir: str, endpo
                 logging.exception(f"{file_path} is not a file")
 
     return file_path
+
+def convert_references_to_openapi3(obj):
+    for key, val in obj.items():
+        if key == '$ref':
+            obj[key] = val.replace('definitions', 'components/schemas')
+
+        if isinstance(val, dict):
+            convert_references_to_openapi3(val)
+
+
+def convert_response_definitions_to_openapi3(response, media_types):
+    if 'schema' in response:
+        convert_references_to_openapi3(response['schema'])
+        if 'content' not in response:
+            response['content'] = {}
+            for media_type in media_types:
+                response['content'][media_type] = {'schema': dict(response['schema'])}
+        del response['schema']
+
+
+def convert_responses_to_openapi3(responses, media_types):
+    for val in responses.values():
+        convert_response_definitions_to_openapi3(val, media_types)