Merge pull request #120 from starlite-api/memoize-openapi-schema

Add OpenAPI Schema Memoization
litestar-org · May 29, 2022 · 8f96f14 · 8f96f14
2 parents 9322c5f + beb7c39
commit 8f96f14
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 46 deletions.
diff --git a/.flake8 b/.flake8
@@ -1,4 +1,4 @@
 [flake8]
 max-line-length = 120
 max-complexity = 12
-ignore = E501, C408, B008, B009, W503, SIM119
+ignore = E501, C408, B008, B009, W503, SIM119, C417
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -84,7 +84,7 @@ repos:
             sqlalchemy,
           ]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v0.950"
+    rev: "v0.960"
     hooks:
       - id: mypy
         additional_dependencies:

diff --git a/docs/usage/16-caching.md b/docs/usage/16-caching.md
@@ -13,7 +13,7 @@ def my_cached_handler() -> str:
 ```
 
 By setting `cache=True` in the route handler, caching for the route handler will be enabled for the default duration,
-which 60 seconds unless modified.
+which is 60 seconds unless modified.
 
 Alternatively you can specify the number of seconds to cache the responses from the given handler like so:
 

diff --git a/poetry.lock b/poetry.lock
diff --git a/starlite/openapi/controller.py b/starlite/openapi/controller.py
@@ -14,6 +14,7 @@ class OpenAPIController(Controller):
         body { margin: 0; padding: 0 }
     """
     redoc_version = "next"
+    dumped_schema = ""
 
     @staticmethod
     def schema_from_request(request: Request) -> OpenAPI:
@@ -35,9 +36,11 @@ def retrieve_schema_json(self, request: Request) -> OpenAPI:
     @get(media_type=MediaType.HTML, include_in_schema=False)
     def redoc(self, request: Request) -> str:  # pragma: no cover
         """Endpoint that serves Redoc"""
-        dumped_schema = dumps(
-            request.app.openapi_schema.json(by_alias=True, exclude_none=True), option=OPT_INDENT_2
-        ).decode("utf-8")
+        if self.dumped_schema == "":
+            schema = self.schema_from_request(request)
+            self.dumped_schema = dumps(schema.json(by_alias=True, exclude_none=True), option=OPT_INDENT_2).decode(
+                "utf-8"
+            )
         head = f"""
           <head>
             <title>{request.app.openapi_schema.info.title}</title>
@@ -55,7 +58,7 @@ def redoc(self, request: Request) -> str:  # pragma: no cover
             <div id='redoc-container'/>
             <script type="text/javascript">
                 Redoc.init(
-                    JSON.parse({dumped_schema}),
+                    JSON.parse({self.dumped_schema}),
                     undefined,
                     document.getElementById('redoc-container')
                 )