Merge pull request #131 from DStape/support-apispec-1.0.0

Support apispec 1.0.0

Author: sloria

.travis.yml

@@ -2,8 +2,6 @@ language: python
 cache: pip
 sudo: false
 env:
-- APISPEC_VERSION="==0.39.0"
-- APISPEC_VERSION=""
 - MARSHMALLOW_VERSION="==2.13.0"
 - MARSHMALLOW_VERSION=""
 python:
@@ -15,7 +13,6 @@ before_install:
 install:
 - travis_retry pip install -U .
 - travis_retry pip install -U -r dev-requirements.txt
-- travis_retry pip install -U --pre apispec"$APISPEC_VERSION"
 - travis_retry pip install -U --pre marshmallow"$MARSHMALLOW_VERSION"
 before_script:
 - flake8 flask_apispec
@@ -29,7 +26,7 @@ jobs:
     env: []
     # Override install, and script to no-ops
     before_install: true
-    install: 
+    install:
     - travis_retry pip install -U .
     - travis_retry pip install -r dev-requirements.txt
     before_script: true

flask_apispec/apidoc.py

@@ -39,13 +39,14 @@ def convert(self, target, endpoint=None, blueprint=None, **kwargs):
     def get_path(self, rule, target, **kwargs):
         operations = self.get_operations(rule, target)
         parent = self.get_parent(target, **kwargs)
+        valid_methods = VALID_METHODS[self.spec.openapi_version.major]
         return {
             'view': target,
             'path': rule_to_path(rule),
             'operations': {
                 method.lower(): self.get_operation(rule, view, parent=parent)
                 for method, view in six.iteritems(operations)
-                if method.lower() in (set(VALID_METHODS) - {'head'})
+                if method.lower() in (set(valid_methods) - {'head'})
             },
         }
 
@@ -84,7 +85,6 @@ def get_parameters(self, rule, view, docs, parent=None):
         locations = options.pop('locations', None)
         if locations:
             options['default_in'] = locations[0]
-        options['spec'] = self.app.config.get('APISPEC_SPEC', None)
 
         rule_params = rule_to_params(rule, docs.get('params')) or []
         extra_params = converter(schema, **options) if args else []

flask_apispec/extension.py

@@ -21,6 +21,7 @@ class FlaskApiSpec(object):
             'APISPEC_SPEC': APISpec(
                 title='pets',
                 version='v1',
+                openapi_version='2.0',
                 plugins=[MarshmallowPlugin()],
             ),
             'APISPEC_SWAGGER_URL': '/swagger/',
@@ -51,7 +52,8 @@ def init_app(self, app):
         self.app = app
         self.spec = self.app.config.get('APISPEC_SPEC') or \
                     make_apispec(self.app.config.get('APISPEC_TITLE', 'flask-apispec'),
-                                 self.app.config.get('APISPEC_VERSION', 'v1'))
+                                 self.app.config.get('APISPEC_VERSION', 'v1'),
+                                 self.app.config.get('APISPEC_OAS_VERSION', '2.0'))
         self.add_swagger_routes()
         self.resource_converter = ResourceConverter(self.app, spec=self.spec)
         self.view_converter = ViewConverter(app=self.app, spec=self.spec)
@@ -143,12 +145,13 @@ def _register(self, target, endpoint=None, blueprint=None,
         else:
             raise TypeError()
         for path in paths:
-            self.spec.add_path(**path)
+            self.spec.path(**path)
 
 
-def make_apispec(title='flask-apispec', version='v1'):
+def make_apispec(title='flask-apispec', version='v1', openapi_version='2.0'):
     return APISpec(
         title=title,
         version=version,
+        openapi_version=openapi_version,
         plugins=[MarshmallowPlugin()],
     )

setup.cfg

@@ -10,5 +10,5 @@ universal=1
 # E301: expected 1 blank line, found 1
 # E302: expected 2 blank lines, found 0
 [flake8]
-ignore = E127,E128,E265,E301,E302
+ignore = E127,E128,E265,E301,E302,W504
 max-line-length = 90

setup.py

@@ -9,7 +9,7 @@
     'flask>=0.10.1',
     'marshmallow>=2.0.0',
     'webargs>=0.18.0',
-    'apispec>=0.17.0',
+    'apispec>=1.0.0',
 ]
 
 def find_version(fname):

tests/test_extension.py

@@ -92,9 +92,9 @@ def test_serve_swagger_ui_custom_url(self, app, client):
     def test_apispec_config(self, app):
         app.config['APISPEC_TITLE'] = 'test-extension'
         app.config['APISPEC_VERSION'] = '2.1'
+        app.config['APISPEC_OAS_VERSION'] = '2.0'
         docs = FlaskApiSpec(app)
 
-        assert docs.spec.info == {
-            'title': 'test-extension',
-            'version': '2.1',
-        }
+        assert docs.spec.title == 'test-extension'
+        assert docs.spec.version == '2.1'
+        assert docs.spec.openapi_version == '2.0'

tests/test_openapi.py

@@ -20,18 +20,24 @@ def spec(marshmallow_plugin):
     return APISpec(
         title='title',
         version='v1',
+        openapi_version='2.0',
         plugins=[marshmallow_plugin],
     )
 
 @pytest.fixture()
 def openapi(marshmallow_plugin):
     return marshmallow_plugin.openapi
 
+def ref_path(spec):
+    if spec.openapi_version.version[0] < 3:
+        return "#/definitions/"
+    return "#/components/schemas/"
 
 def test_error_if_spec_does_not_have_marshmallow_plugin(app):
     bad_spec = APISpec(
         title='title',
         version='v1',
+        openapi_version='2.0',
         plugins=[],  # oh no! no MarshmallowPlugin
     )
     with pytest.raises(RuntimeError):
@@ -57,7 +63,7 @@ def path(self, app, spec, function_view):
         converter = ViewConverter(app=app, spec=spec)
         paths = converter.convert(function_view)
         for path in paths:
-            spec.add_path(**path)
+            spec.path(**path)
         return spec._paths['/bands/{band_id}/']
 
     def test_params(self, app, path):
@@ -77,8 +83,7 @@ def test_params(self, app, path):
     def test_responses(self, schemas, path, openapi):
         response = path['get']['responses']['default']
         assert response['description'] == 'a band'
-        expected = openapi.schema2jsonschema(schemas.BandSchema)
-        assert response['schema'] == expected
+        assert response['schema'] == {'$ref': ref_path(openapi.spec) + 'Band'}
 
     def test_tags(self, path):
         assert path['get']['tags'] == ['band']
@@ -101,7 +106,7 @@ def path(self, app, spec, function_view):
         converter = ViewConverter(app=app, spec=spec)
         paths = converter.convert(function_view)
         for path in paths:
-            spec.add_path(**path)
+            spec.path(**path)
         return spec._paths['/bands/{band_id}/']
 
     def test_params(self, app, path, openapi):
@@ -145,7 +150,7 @@ def path(self, app, spec, function_view):
         converter = ViewConverter(app=app, spec=spec)
         paths = converter.convert(function_view)
         for path in paths:
-            spec.add_path(**path)
+            spec.path(**path)
         return spec._paths['/bands/{band_id}/']
 
     def test_responses(self, schemas, path):
@@ -172,7 +177,7 @@ def path(self, app, spec, resource_view):
         converter = ResourceConverter(app=app, spec=spec)
         paths = converter.convert(resource_view, endpoint='band')
         for path in paths:
-            spec.add_path(**path)
+            spec.path(**path)
         return spec._paths['/bands/{band_id}/']
 
     def test_params(self, app, path, openapi):
@@ -188,8 +193,7 @@ def test_params(self, app, path, openapi):
     def test_responses(self, schemas, path, openapi):
         response = path['get']['responses']['default']
         assert response['description'] == 'a band'
-        expected = openapi.schema2jsonschema(schemas.BandSchema)
-        assert response['schema'] == expected
+        assert response['schema'] == {'$ref': ref_path(openapi.spec) + 'Band'}
 
     def test_tags(self, path):
         assert path['get']['tags'] == ['band']