APIFlask 2.3.2__tar.gz → 2.4.0__tar.gz

{apiflask-2.3.2 → apiflask-2.4.0}/CHANGES.md

@@ -1,3 +1,14 @@
+## Version 2.4.0
+
+Released: 2025/3/25
+
+- Add `docs_oauth2_redirect_path_external` parameter to support absolute OAuth2 redirect url ([issue #602][issue_602]).
+- Change the default docs CDN to jsDelivr by default instead of unpkg ([pr #650](pr_650)).
+
+[issue_602]: https://github.com/apiflask/apiflask/issues/602
+[pr_650]: https://github.com/apiflask/apiflask/pull/650
+
+
 ## Version 2.3.2
 
 Released: 2024/12/15

{apiflask-2.3.2 → apiflask-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: APIFlask
-Version: 2.3.2
+Version: 2.4.0
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT
@@ -41,6 +41,7 @@ Provides-Extra: async
 Requires-Dist: asgiref>=3.2; extra == "async"
 Provides-Extra: yaml
 Requires-Dist: pyyaml; extra == "yaml"
+Dynamic: license-file
 
 
 ![](https://apiflask.com/_assets/apiflask-logo.png)

{apiflask-2.3.2 → apiflask-2.4.0}/examples/openapi/static_docs/index.html

@@ -4,7 +4,7 @@
 <head>
   <meta charset="UTF-8">
   <title>APIFlask 0.1.0 - Swagger UI</title>
-  <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist/swagger-ui.css">
+  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.css">
   <link rel="icon" type="image/png"
     href="https://apiflask.com/_assets/favicon.png">
   <style>
@@ -30,8 +30,8 @@
 <body>
   <div id="swagger-ui"></div>
 
-  <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
-  <script src="https://unpkg.com/swagger-ui-dist/swagger-ui-standalone-preset.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-bundle.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui-standalone-preset.js"></script>
   <script>
     // we can get several config items of Function type
     // referring to https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/

{apiflask-2.3.2 → apiflask-2.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ description = "A lightweight web API framework based on Flask and marshmallow-co
 readme = "README.md"
 license = { text = "MIT" }
 authors = [{ name = "Grey Li", email = "withlihui@gmail.com" }]
-version = "2.3.2"
+version = "2.4.0"
 classifiers = [
     "Development Status :: 3 - Alpha",
     "Environment :: Web Environment",

{apiflask-2.3.2 → apiflask-2.4.0}/src/APIFlask.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: APIFlask
-Version: 2.3.2
+Version: 2.4.0
 Summary: A lightweight web API framework based on Flask and marshmallow-code projects.
 Author-email: Grey Li <withlihui@gmail.com>
 License: MIT
@@ -41,6 +41,7 @@ Provides-Extra: async
 Requires-Dist: asgiref>=3.2; extra == "async"
 Provides-Extra: yaml
 Requires-Dist: pyyaml; extra == "yaml"
+Dynamic: license-file
 
 
 ![](https://apiflask.com/_assets/apiflask-logo.png)

{apiflask-2.3.2 → apiflask-2.4.0}/src/apiflask/app.py

@@ -16,6 +16,7 @@ from flask import json
 from flask import jsonify
 from flask import render_template_string
 from flask import request
+from flask import url_for
 from flask.config import ConfigAttribute
 from flask.wrappers import Response
 
@@ -268,6 +269,7 @@ class APIFlask(APIScaffold, Flask):
         spec_path: str | None = '/openapi.json',
         docs_path: str | None = '/docs',
         docs_oauth2_redirect_path: str | None = '/docs/oauth2-redirect',
+        docs_oauth2_redirect_path_external: bool = False,
         docs_ui: str = 'swagger-ui',
         openapi_blueprint_url_prefix: str | None = None,
         json_errors: bool = True,
@@ -299,6 +301,8 @@ class APIFlask(APIScaffold, Flask):
             docs_ui: The UI of API documentation, one of `swagger-ui` (default), `redoc`,
                 `elements`, `rapidoc`, and `rapipdf`.
             docs_oauth2_redirect_path: The path to Swagger UI OAuth redirect.
+            docs_oauth2_redirect_path_external: If `True`, the `docs_oauth2_redirect_path`
+                will be an external URL.
             openapi_blueprint_url_prefix: The url prefix of the OpenAPI blueprint. This
                 prefix will append before all the OpenAPI-related paths (`sepc_path`,
                 `docs_path`, etc.), defaults to `None`.
@@ -348,6 +352,7 @@ class APIFlask(APIScaffold, Flask):
         self.docs_ui = docs_ui
         self.docs_path = docs_path
         self.docs_oauth2_redirect_path = docs_oauth2_redirect_path
+        self.docs_oauth2_redirect_path_external = docs_oauth2_redirect_path_external
         self.openapi_blueprint_url_prefix = openapi_blueprint_url_prefix
         self.enable_openapi = enable_openapi
         self.json_errors = json_errors
@@ -509,6 +514,10 @@ class APIFlask(APIScaffold, Flask):
         The name of the blueprint is "openapi". This blueprint will hold the view
         functions for spec file and API docs.
 
+        *Version changed: 2.3.3*
+
+        - Add 'docs_oauth2_redirect_path_external' parameter to support absolute redirect url.
+
         *Version changed: 2.1.0*
 
         - Inject the OpenAPI endpoints decorators.
@@ -549,11 +558,20 @@ class APIFlask(APIScaffold, Flask):
             @bp.route(self.docs_path)
             @self._apply_decorators(config_name='DOCS_DECORATORS')
             def docs():
+                docs_oauth2_redirect_path = None
+                if self.docs_ui == 'swagger-ui':
+                    if self.docs_oauth2_redirect_path_external:
+                        docs_oauth2_redirect_path = url_for(
+                            'openapi.swagger_ui_oauth_redirect', _external=True
+                        )
+                    else:
+                        docs_oauth2_redirect_path = self.docs_oauth2_redirect_path
+
                 return render_template_string(
                     ui_templates[self.docs_ui],
                     title=self.title,
                     version=self.version,
-                    oauth2_redirect_path=self.docs_oauth2_redirect_path,
+                    oauth2_redirect_path=docs_oauth2_redirect_path,
                 )
 
             if self.docs_ui == 'swagger-ui':

{apiflask-2.3.2 → apiflask-2.4.0}/src/apiflask/settings.py

@@ -57,22 +57,22 @@ REDOC_USE_GOOGLE_FONT: bool = True
 REDOC_STANDALONE_JS: str = 'https://cdn.redoc.ly/redoc/latest/bundles/\
 redoc.standalone.js'  # TODO: rename to REDOC_JS
 REDOC_CONFIG: dict | None = None
-SWAGGER_UI_CSS: str = 'https://unpkg.com/swagger-ui-dist/swagger-ui.css'
-SWAGGER_UI_BUNDLE_JS: str = 'https://unpkg.com/swagger-ui-dist/\
+SWAGGER_UI_CSS: str = 'https://cdn.jsdelivr.net/npm/swagger-ui-dist/swagger-ui.css'
+SWAGGER_UI_BUNDLE_JS: str = 'https://cdn.jsdelivr.net/npm/swagger-ui-dist/\
 swagger-ui-bundle.js'  # TODO: rename to SWAGGER_UI_JS
-SWAGGER_UI_STANDALONE_PRESET_JS: str = 'https://unpkg.com/swagger-ui-dist/\
+SWAGGER_UI_STANDALONE_PRESET_JS: str = 'https://cdn.jsdelivr.net/npm/swagger-ui-dist/\
 swagger-ui-standalone-preset.js'  # TODO: rename to SWAGGER_UI_STANDALONE_JS
 SWAGGER_UI_LAYOUT: str = 'BaseLayout'
 SWAGGER_UI_CONFIG: dict | None = None
 SWAGGER_UI_OAUTH_CONFIG: dict | None = None
-ELEMENTS_JS: str = 'https://unpkg.com/@stoplight/elements/web-components.min.js'
-ELEMENTS_CSS: str = 'https://unpkg.com/@stoplight/elements/styles.min.css'
+ELEMENTS_JS: str = 'https://cdn.jsdelivr.net/npm/@stoplight/elements/web-components.min.js'
+ELEMENTS_CSS: str = 'https://cdn.jsdelivr.net/npm/@stoplight/elements/styles.min.css'
 ELEMENTS_LAYOUT: str = 'sidebar'
 ELEMENTS_CONFIG: dict | None = None
-RAPIDOC_JS: str = 'https://unpkg.com/rapidoc/dist/rapidoc-min.js'
+RAPIDOC_JS: str = 'https://cdn.jsdelivr.net/npm/rapidoc/dist/rapidoc-min.js'
 RAPIDOC_THEME: str = 'light'
 RAPIDOC_CONFIG: dict | None = None
-RAPIPDF_JS: str = 'https://unpkg.com/rapipdf/dist/rapipdf-min.js'
+RAPIPDF_JS: str = 'https://cdn.jsdelivr.net/npm/rapipdf/dist/rapipdf-min.js'
 RAPIPDF_CONFIG: dict | None = None
 
 # Version changed: 1.2.0

{apiflask-2.3.2 → apiflask-2.4.0}/tests/test_openapi_blueprint.py

@@ -69,6 +69,19 @@ def test_docs_oauth2_redirect_path(client):
     assert rv.status_code == 200
     assert b'oauth2RedirectUrl: "/docs/oauth2/redirect"' in rv.data
 
+    # Test the feature of external oauth2 redirect path
+    app = APIFlask(
+        __name__,
+        docs_oauth2_redirect_path='/docs/oauth2/redirect/external',
+        docs_oauth2_redirect_path_external=True,
+    )
+    rv = app.test_client().get('/docs/oauth2/redirect/external')
+    assert rv.status_code == 200
+    assert b'<title>Swagger UI: OAuth2 Redirect</title>' in rv.data
+    rv = app.test_client().get('/docs')
+    assert rv.status_code == 200
+    assert b'oauth2RedirectUrl: "http://localhost/docs/oauth2/redirect/external"' in rv.data
+
     app = APIFlask(__name__, docs_oauth2_redirect_path=None)
     assert app.docs_oauth2_redirect_path is None