takibi-swagger-ui 0.1.0__tar.gz

takibi_swagger_ui-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 - present, takibi-swagger-ui Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

takibi_swagger_ui-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: takibi-swagger-ui
+Version: 0.1.0
+Summary: Swagger UI middleware for a takibiapi app
+Keywords: openapi,swagger-ui,asgi,takibiapi
+Author: nakita628
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Typing :: Typed
+Requires-Dist: takibiapi>=0.1.0,<0.2
+Requires-Python: >=3.12
+Project-URL: Repository, https://github.com/nakita628/takibi
+Project-URL: Issues, https://github.com/nakita628/takibi/issues
+Description-Content-Type: text/markdown
+
+# takibi-swagger-ui
+
+Swagger UI for a [TakibiAPI](../takibiapi) app (or its [pydantic](../pydantic-takibiapi) / [zopy](../zopy-takibiapi) flavors), as Hono's [`@hono/swagger-ui`](https://github.com/honojs/middleware/tree/main/packages/swagger-ui).
+
+```sh
+pip install takibi-swagger-ui
+```
+
+```python
+from takibiapi import TakibiAPI
+from takibi_swagger_ui import swaggerUI
+
+app = TakibiAPI()
+# app.openapi(route, handler) ...
+app.doc("/doc", {"openapi": "3.1.0", "info": {"title": "My API", "version": "1.0.0"}})
+app.use(swaggerUI({"url": "/doc"}), prefix="/ui")  # GET /ui: the Swagger UI page
+```
+
+The page loads `swagger-ui-dist` from jsDelivr (`"version": "5.17.14"` pins it) and the document from `url`.
+
+## Options
+
+- `title`: the page's `<title>` (default `SwaggerUI`).
+- `version`: the `swagger-ui-dist` version.
+- `manuallySwaggerUIHtml`: `(asset) -> str`, the page body built from `asset["css"]` / `asset["js"]`.
+- Everything else is [Swagger UI's configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) (`url`, `urls`, `spec`, `deepLinking`, `docExpansion`, `persistAuthorization`, ...), written as JSON. `presets`, `plugins`, `requestInterceptor`, `responseInterceptor`, `onComplete`, `operationsSorter`, `tagsSorter`, `modelPropertyMacro` and `parameterMacro` are JavaScript source and written as they are:
+
+```python
+swaggerUI({"url": "/doc", "requestInterceptor": "(req) => { req.headers['x-api-key'] = 'dev'; return req }"})
+```
+
+`SwaggerUI(options)` returns the markup alone, to put in a page of your own.
+
+## Development
+
+From the repository root: `bazel test //pypi/takibi-swagger-ui:test`. See the root README. `apps/examples/src/examples/todo.py` serves it (`just serve`, then http://localhost:8000/ui).
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/nakita628/takibi/blob/main/pypi/takibi-swagger-ui/LICENSE) for more information.

takibi_swagger_ui-0.1.0/README.md

@@ -0,0 +1,40 @@
+# takibi-swagger-ui
+
+Swagger UI for a [TakibiAPI](../takibiapi) app (or its [pydantic](../pydantic-takibiapi) / [zopy](../zopy-takibiapi) flavors), as Hono's [`@hono/swagger-ui`](https://github.com/honojs/middleware/tree/main/packages/swagger-ui).
+
+```sh
+pip install takibi-swagger-ui
+```
+
+```python
+from takibiapi import TakibiAPI
+from takibi_swagger_ui import swaggerUI
+
+app = TakibiAPI()
+# app.openapi(route, handler) ...
+app.doc("/doc", {"openapi": "3.1.0", "info": {"title": "My API", "version": "1.0.0"}})
+app.use(swaggerUI({"url": "/doc"}), prefix="/ui")  # GET /ui: the Swagger UI page
+```
+
+The page loads `swagger-ui-dist` from jsDelivr (`"version": "5.17.14"` pins it) and the document from `url`.
+
+## Options
+
+- `title`: the page's `<title>` (default `SwaggerUI`).
+- `version`: the `swagger-ui-dist` version.
+- `manuallySwaggerUIHtml`: `(asset) -> str`, the page body built from `asset["css"]` / `asset["js"]`.
+- Everything else is [Swagger UI's configuration](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/) (`url`, `urls`, `spec`, `deepLinking`, `docExpansion`, `persistAuthorization`, ...), written as JSON. `presets`, `plugins`, `requestInterceptor`, `responseInterceptor`, `onComplete`, `operationsSorter`, `tagsSorter`, `modelPropertyMacro` and `parameterMacro` are JavaScript source and written as they are:
+
+```python
+swaggerUI({"url": "/doc", "requestInterceptor": "(req) => { req.headers['x-api-key'] = 'dev'; return req }"})
+```
+
+`SwaggerUI(options)` returns the markup alone, to put in a page of your own.
+
+## Development
+
+From the repository root: `bazel test //pypi/takibi-swagger-ui:test`. See the root README. `apps/examples/src/examples/todo.py` serves it (`just serve`, then http://localhost:8000/ui).
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/nakita628/takibi/blob/main/pypi/takibi-swagger-ui/LICENSE) for more information.

takibi_swagger_ui-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "takibi-swagger-ui"
+version = "0.1.0"
+description = "Swagger UI middleware for a takibiapi app"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = [
+    "openapi",
+    "swagger-ui",
+    "asgi",
+    "takibiapi",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Typing :: Typed",
+]
+dependencies = ["takibiapi>=0.1.0,<0.2"]
+
+[[project.authors]]
+name = "nakita628"
+
+[project.urls]
+Repository = "https://github.com/nakita628/takibi"
+Issues = "https://github.com/nakita628/takibi/issues"
+
+[build-system]
+requires = ["uv_build>=0.8,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = "python"
+module-name = "takibi_swagger_ui"
+
+[tool.uv.sources.takibiapi]
+workspace = true

takibi_swagger_ui-0.1.0/pyproject.toml.orig

@@ -0,0 +1,37 @@
+[project]
+name = "takibi-swagger-ui"
+version = "0.1.0"
+description = "Swagger UI middleware for a takibiapi app"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "nakita628" }]
+keywords = ["openapi", "swagger-ui", "asgi", "takibiapi"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
+    "Typing :: Typed",
+]
+dependencies = ["takibiapi>=0.1.0,<0.2"]
+
+[project.urls]
+Repository = "https://github.com/nakita628/takibi"
+Issues = "https://github.com/nakita628/takibi/issues"
+
+[build-system]
+requires = ["uv_build>=0.8,<0.14"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = "python"
+module-name = "takibi_swagger_ui"
+
+[tool.uv.sources]
+takibiapi = { workspace = true }

takibi_swagger_ui-0.1.0/python/takibi_swagger_ui/__init__.py

@@ -0,0 +1,162 @@
+"""takibi-swagger-ui: Swagger UI for a takibiapi app, as Hono's ``@hono/swagger-ui``.
+
+    from takibi_swagger_ui import swaggerUI
+
+    app.doc("/doc", {"openapi": "3.1.0", "info": {"title": "My API", "version": "1.0.0"}})
+    app.use(swaggerUI({"url": "/doc"}), prefix="/ui")
+
+``GET /ui`` answers the Swagger UI page, which loads ``swagger-ui-dist`` from jsDelivr and the
+document from ``url``. Other methods pass through to the app.
+"""
+
+from __future__ import annotations
+
+import html
+import json
+from collections.abc import Callable, Sequence
+from typing import Any, TypedDict
+
+from takibiapi import Context, Middleware, Next, Response
+
+
+class Asset(TypedDict):
+    css: list[str]
+    js: list[str]
+
+
+class SwaggerUIOptions(TypedDict, total=False):
+    """``title`` and ``version`` are this package's; the other keys are Swagger UI's
+    configuration (https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/)."""
+
+    title: str  # <title> of the page (default "SwaggerUI")
+    version: str  # swagger-ui-dist version on jsDelivr (default: latest)
+    manuallySwaggerUIHtml: Callable[[Asset], str]  # the page body, built from the asset URLs
+    url: str
+    urls: list[dict[str, str]]
+    spec: dict[str, Any]
+    configUrl: str
+    layout: str
+    docExpansion: str
+    deepLinking: bool
+    displayOperationId: bool
+    defaultModelsExpandDepth: int
+    defaultModelExpandDepth: int
+    defaultModelRendering: str
+    displayRequestDuration: bool
+    filter: bool | str
+    maxDisplayedTags: int
+    showExtensions: bool
+    showCommonExtensions: bool
+    queryConfigEnabled: bool
+    persistAuthorization: bool
+    tryItOutEnabled: bool
+    requestSnippetsEnabled: bool
+    requestSnippets: dict[str, Any]
+    syntaxHighlight: bool | dict[str, Any]
+    supportedSubmitMethods: list[str]
+    validatorUrl: str | None
+    withCredentials: bool
+    oauth2RedirectUrl: str
+    # JavaScript, written into the page as it is:
+    presets: Sequence[str]  # e.g. ["SwaggerUIBundle.presets.apis", "SwaggerUIStandalonePreset"]
+    plugins: Sequence[str]
+    requestInterceptor: str  # e.g. "(req) => req"
+    responseInterceptor: str
+    onComplete: str
+    operationsSorter: str
+    tagsSorter: str
+    modelPropertyMacro: str
+    parameterMacro: str
+
+
+# Keys whose values are JavaScript source (a list of expressions, or one expression) rather than data.
+_JS_LISTS = frozenset({"presets", "plugins"})
+_JS = frozenset(
+    {
+        "requestInterceptor",
+        "responseInterceptor",
+        "onComplete",
+        "operationsSorter",
+        "tagsSorter",
+        "modelPropertyMacro",
+        "parameterMacro",
+    }
+)
+_OWN = frozenset({"title", "version", "manuallySwaggerUIHtml"})
+
+
+def remote_assets(version: str | None = None) -> Asset:
+    """The swagger-ui-dist stylesheet and script on jsDelivr."""
+    base = f"https://cdn.jsdelivr.net/npm/swagger-ui-dist{'@' + version if version else ''}"
+    return {"css": [f"{base}/swagger-ui.css"], "js": [f"{base}/swagger-ui-bundle.js"]}
+
+
+def _js_value(value: Any) -> str:
+    # JSON inside <script>: "<" escaped so a value cannot close the tag.
+    return json.dumps(value, ensure_ascii=False).replace("<", "\\u003c")
+
+
+def render_options(options: SwaggerUIOptions) -> str:
+    """The options as the properties of the ``SwaggerUIBundle({...})`` object literal."""
+    parts: list[str] = []
+    items: dict[str, Any] = dict(options)
+    for key, value in items.items():
+        if key in _OWN:
+            continue
+        if value is None:
+            if key == "validatorUrl":  # null turns the validator badge off
+                parts.append("validatorUrl: null")
+            continue
+        if key in _JS_LISTS:
+            rendered = "[" + ",".join(str(v) for v in value) + "]"
+        elif key in _JS and isinstance(value, str):
+            rendered = value
+        else:
+            rendered = _js_value(value)
+        parts.append(f"{key}: {rendered}")
+    return ",\n            ".join(parts)
+
+
+def SwaggerUI(options: SwaggerUIOptions) -> str:  # noqa: N802
+    """The Swagger UI markup (the page's body)."""
+    asset = remote_assets(options.get("version"))
+    manual = options.get("manuallySwaggerUIHtml")
+    if manual is not None:
+        return manual(asset)
+    links = "".join(f'<link rel="stylesheet" href="{html.escape(u)}" />' for u in asset["css"])
+    scripts = "".join(f'<script src="{html.escape(u)}" crossorigin="anonymous"></script>' for u in asset["js"])
+    rendered = render_options(options)
+    return f"""<div>
+      <div id="swagger-ui"></div>
+      {links}
+      {scripts}
+      <script>
+        window.onload = () => {{
+          window.ui = SwaggerUIBundle({{
+            dom_id: '#swagger-ui',{"" if not rendered else chr(10) + "            " + rendered},
+          }})
+        }}
+      </script>
+    </div>"""
+
+
+def swaggerUI(options: SwaggerUIOptions) -> Middleware:  # noqa: N802
+    """The Swagger UI page as middleware: ``app.use(swaggerUI({"url": "/doc"}), prefix="/ui")``."""
+    title = html.escape(options.get("title", "SwaggerUI"))
+    page = (
+        '<!doctype html><html lang="en"><head><meta charset="utf-8" />'
+        '<meta name="viewport" content="width=device-width, initial-scale=1" />'
+        '<meta name="description" content="SwaggerUI" />'
+        f"<title>{title}</title></head><body>{SwaggerUI(options)}</body></html>"
+    ).encode()
+
+    async def middleware(c: Context[Any], next: Next) -> Response:
+        if c.req.method not in ("GET", "HEAD"):
+            return await next()
+        return Response(page, 200, {"content-type": "text/html; charset=utf-8"})
+
+    return middleware
+
+
+__all__ = ["Asset", "SwaggerUI", "SwaggerUIOptions", "remote_assets", "render_options", "swaggerUI"]
+__version__ = "0.1.0"