feat: add scalar openapi ui, update swagger version to 5 (#369)

* feat: add scalar openapi ui, update swagger version to 5 Signed-off-by: Keming <kemingy94@gmail.com> * fix lint Signed-off-by: Keming <kemingy94@gmail.com> * make mypy happy Signed-off-by: Keming <kemingy94@gmail.com> --------- Signed-off-by: Keming <kemingy94@gmail.com>
0b01001001 · Jan 26, 2024 · e1b3cba · e1b3cba
1 parent bc22adf
commit e1b3cba
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 34 deletions.
diff --git a/Makefile b/Makefile
@@ -42,6 +42,7 @@ publish: package
 
 format:
 	@ruff format ${SOURCE_FILES}
+	@ruff check --fix ${PY_SOURCE}
 
 lint:
 	@ruff check ${SOURCE_FILES}

diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ Check the [examples](examples) folder.
    * falcon: `req.context`
    * starlette: `request.context`
 5. register to the web application `api.register(app)`
-6. check the document at URL location `/apidoc/redoc` or `/apidoc/swagger`
+6. check the document at URL location `/apidoc/redoc` or `/apidoc/swagger` or `/apidoc/scalar`
 
 If the request doesn't pass the validation, it will return a 422 with a JSON error message(ctx, loc, msg, type).
 

diff --git a/examples/flask_view.py b/examples/flask_view.py
@@ -0,0 +1,25 @@
+from flask import Flask, jsonify
+from flask.views import MethodView
+from pydantic import BaseModel
+
+from spectree import SpecTree
+
+app = Flask(__name__)
+spec = SpecTree("flask", annotations=True)
+
+
+class User(BaseModel):
+    name: str
+    token: str
+
+
+class Login(MethodView):
+    @spec.validate()
+    def post(self, json: User):
+        print(json)
+        return jsonify({"msg": "success"})
+
+
+if __name__ == "__main__":
+    app.add_url_rule("/login", view_func=Login.as_view("login"))
+    app.run(debug=True)
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "spectree"
-version = "1.2.8"
+version = "1.2.9"
 dynamic = []
 description = "generate OpenAPI document and validate request&response with Python annotations."
 readme = "README.md"

diff --git a/spectree/page.py b/spectree/page.py
@@ -36,37 +36,17 @@
 <html lang="en">
     <head>
         <meta charset="UTF-8">
-        <title>Swagger UI</title>
-        <link rel="stylesheet" type="text/css"
-        href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui.css" >
-        <style>
-        html
-        {{
-            box-sizing: border-box;
-            overflow: -moz-scrollbars-vertical;
-            overflow-y: scroll;
-        }}
-
-        *,
-        *:before,
-        *:after
-        {{
-            box-sizing: inherit;
-        }}
-
-        body
-        {{
-            margin:0;
-            background: #fafafa;
-        }}
-        </style>
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <meta name="description" content="SwaggerUI"/>
+        <title>SwaggerUI</title>
+        <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui.css" />
     </head>
 
     <body>
         <div id="swagger-ui"></div>
 
-        <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui-bundle.js"></script>
-        <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@4/swagger-ui-standalone-preset.js"></script>
+        <script src="https://unpkg.com/swagger-ui-dist@5.0.0/swagger-ui-bundle.js" crossorigin></script>
+        <script src="https://unpkg.com/swagger-ui-dist@5.0.0/swagger-ui-standalone-preset.js" crossorigin></script>
         <script>
         window.onload = function() {{
         var full = location.protocol + '//' + location.hostname + (location.port ? ':' + location.port : '');
@@ -177,5 +157,36 @@
     }});
 </script>
 </body>
+</html>""",
+    "scalar": """
+<!doctype html>
+<html>
+  <head>
+    <title>API Reference</title>
+    <meta charset="utf-8" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1" />
+    <style>
+      body {{
+        margin: 0;
+      }}
+    </style>
+  </head>
+  <body>
+    <script
+      id="api-reference"
+      data-url="{spec_url}">
+    </script>
+    <script>
+      var configuration = {{
+        theme: 'purple',
+      }}
+
+      var apiReference = document.getElementById('api-reference')
+      apiReference.dataset.configuration = JSON.stringify(configuration)
+    </script>
+    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>
+  </body>
 </html>""",
 }
diff --git a/spectree/plugins/flask_plugin.py b/spectree/plugins/flask_plugin.py
@@ -50,10 +50,10 @@ def parse_func(self, route: Any):
             func = current_app.view_functions[route.endpoint]
 
         # view class: https://flask.palletsprojects.com/en/1.1.x/views/
-        if getattr(func, "view_class", None):
-            cls = func.view_class
+        view_cls = getattr(func, "view_class", None)
+        if view_cls:
             for method in route.methods:
-                view = getattr(cls, method.lower(), None)
+                view = getattr(view_cls, method.lower(), None)
                 if view:
                     yield method, view
         else:

diff --git a/spectree/plugins/quart_plugin.py b/spectree/plugins/quart_plugin.py
@@ -53,10 +53,10 @@ def parse_func(self, route: Any):
             func = current_app.view_functions[route.endpoint]
 
         # view class: https://flask.palletsprojects.com/en/1.1.x/views/
-        if getattr(func, "view_class", None):
-            cls = func.view_class
+        view_cls = getattr(func, "view_class", None)
+        if view_cls:
             for method in route.methods:
-                view = getattr(cls, method.lower(), None)
+                view = getattr(view_cls, method.lower(), None)
                 if view:
                     yield method, view
         else:
-Original file line number
+Diff line change
@@ Expand Up / @@ -42,6 +42,7 @@ publish: package @@
     format:
     	@ruff format ${SOURCE_FILES}
+    	@ruff check --fix ${PY_SOURCE}
     lint:
     	@ruff check ${SOURCE_FILES}
@@ Expand Down @@