feat: provide simple default openapi spec

README.md

@@ -29,6 +29,7 @@ $env:FLASK_APP="application.py" # or set the var in `.env`
 python -m flask run #(use -p to specify binding port)
 ```
 
+NOTE: the swagger docs is at http://localhost:5000/docs/swagger
 
 ## Todo List
 

config.py

@@ -1,6 +1,8 @@
 import logging
 import os
 
+from tools.openapi_default import SPEC_OPTIONS
+
 log = logging.getLogger(__name__)
 
 
@@ -21,6 +23,7 @@ class Config:
     OPENAPI_URL_PREFIX = '/docs'
     OPENAPI_SWAGGER_UI_PATH = '/swagger'
     OPENAPI_SWAGGER_UI_VERSION = '3.23.4'
+    API_SPEC_OPTIONS = SPEC_OPTIONS
 
     PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
 

tools/openapi_default.py

@@ -0,0 +1,10 @@
+SPEC_OPTIONS = {
+    'info': {'description': 'Server API document'},
+    'servers': [
+        {
+            'url': 'http://localhost:{port}/',
+            'description': 'The development API server',
+            'variables': {'port': {'enum': ['5000', '8888'], 'default': '5000'}},
+        }
+    ],
+}