Add APIFAIRY_APISPEC_VERSION config option

Author: Danthewaann

docs/intro.rst

@@ -91,6 +91,7 @@ Name                            Type   Default         Description
 ``APIFAIRY_TITLE``              String No title        The API's title.
 ``APIFAIRY_VERSION``            String No version      The API's version.
 ``APIFAIRY_APISPEC_PATH``       String */apispec.json* The URL path where the JSON OpenAPI specification for this project is served.
+``APIFAIRY_APISPEC_VERSION``    String ``None``        The version of the OpenAPI specification to generate for this project.
 ``APIFAIRY_APISPEC_DECORATORS`` List   []              A list of decorators to apply to the JSON OpenAPI endpoint.
 ``APIFAIRY_UI``                 String redoc           The documentation format to use. Supported formats are "redoc", "swagger_ui", "rapidoc" and "elements".
 ``APIFAIRY_UI_PATH``            String */docs*         The URL path where the documentation is served.

src/apifairy/core.py

@@ -46,6 +46,7 @@ def init_app(self, app):
         self.version = app.config.get('APIFAIRY_VERSION', 'No version')
         self.apispec_path = app.config.get('APIFAIRY_APISPEC_PATH',
                                            '/apispec.json')
+        self.apispec_version = app.config.get('APIFAIRY_APISPEC_VERSION', None)
         self.apispec_decorators = app.config.get(
             'APIFAIRY_APISPEC_DECORATORS', [])
         self.ui = app.config.get('APIFAIRY_UI', 'redoc')
@@ -147,10 +148,11 @@ def resolver(schema):
             tags[name] = tag
         tag_list = [tags[name] for name in tag_names]
         ma_plugin = MarshmallowPlugin(schema_name_resolver=resolver)
+        oas_version = '3.1.0' if _webhooks else self.apispec_version or '3.0.3'
         spec = APISpec(
             title=self.title,
             version=self.version,
-            openapi_version='3.1.0' if _webhooks else '3.0.3',
+            openapi_version=oas_version,
             plugins=[ma_plugin],
             info=info,
             servers=servers,

tests/test_apifairy.py

@@ -23,25 +23,25 @@ class Schema(ma.Schema):
     class Meta:
         unknown = EXCLUDE
 
-    id = ma.Integer(default=123)
+    id = ma.Integer(load_default=123, dump_default=123)
     name = ma.Str(required=True)
 
 
 class Schema2(ma.Schema):
     class Meta:
         unknown = EXCLUDE
 
-    id2 = ma.Integer(default=123)
+    id2 = ma.Integer(load_default=123, dump_default=123)
     name2 = ma.Str(required=True)
 
 
 class FooSchema(ma.Schema):
-    id = ma.Integer(default=123)
+    id = ma.Integer(load_default=123, dump_default=123)
     name = ma.Str()
 
 
 class QuerySchema(ma.Schema):
-    id = ma.Integer(missing=1)
+    id = ma.Integer(load_default=1)
 
 
 class FormSchema(ma.Schema):
@@ -140,6 +140,26 @@ def test_no_apispec_path(self):
         rv = client.get('/apispec.json')
         assert rv.status_code == 404
 
+    def test_custom_apispec_version(self):
+        app, _ = self.create_app(config={'APIFAIRY_APISPEC_VERSION': '3.1.0'})
+
+        client = app.test_client()
+        rv = client.get('/apispec.json')
+        assert rv.status_code == 200
+        assert set(rv.json.keys()) == {
+            'openapi', 'info', 'servers', 'paths', 'tags'}
+        assert rv.json['openapi'] == '3.1.0'
+
+    def test_custom_apispec_no_version(self):
+        app, _ = self.create_app(config={'APIFAIRY_APISPEC_VERSION': None})
+
+        client = app.test_client()
+        rv = client.get('/apispec.json')
+        assert rv.status_code == 200
+        assert set(rv.json.keys()) == {
+            'openapi', 'info', 'servers', 'paths', 'tags'}
+        assert rv.json['openapi'] == '3.0.3'
+
     def test_ui(self):
         app, _ = self.create_app(config={'APIFAIRY_UI': 'swagger_ui'})
 
@@ -230,7 +250,7 @@ def foo(schema):
 
         rv = client.post('/foo', json={'name': 'bar'})
         assert rv.status_code == 200
-        assert rv.json == {'name': 'bar'}
+        assert rv.json == {'id': 123, 'name': 'bar'}
 
     def test_body_form(self):
         app, _ = self.create_app()