fastapi-rapidoc-router 0.1.0__tar.gz

fastapi_rapidoc_router-0.1.0/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: fastapi-rapidoc-router
+Version: 0.1.0
+Summary: Simple reusable RapiDoc router for FastAPI OpenAPI specs
+Keywords: fastapi,rapidoc,openapi,docs
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Framework :: FastAPI
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.100.0
+
+# fastapi-rapidoc-router
+
+Simple reusable RapiDoc router for FastAPI projects.
+
+## Install
+
+```bash
+pip install .
+```
+
+Or from a Git repository:
+
+```bash
+pip install git+https://github.com/<your-org>/<your-repo>.git
+```
+
+## Usage
+
+```python
+from fastapi import FastAPI
+from rapidoc_fastapi import mount_rapidoc
+
+app = FastAPI(docs_url=None, redoc_url=None)
+
+@app.get("/health")
+def health() -> dict[str, str]:
+    return {"status": "ok"}
+
+mount_rapidoc(app, docs_path="/docs", title="My API Docs")
+```
+
+## Router API
+
+```python
+from rapidoc_fastapi import create_rapidoc_router
+
+router = create_rapidoc_router(
+    docs_path="/docs",
+    openapi_url="/openapi.json",
+    title="My API Docs",
+)
+
+app.include_router(router)
+```
+
+## Notes
+
+- `docs_path` controls where RapiDoc UI is served.
+- `openapi_url` defaults to the app OpenAPI endpoint.
+- This package uses the official RapiDoc script from CDN by default.

fastapi_rapidoc_router-0.1.0/README.md

@@ -0,0 +1,50 @@
+# fastapi-rapidoc-router
+
+Simple reusable RapiDoc router for FastAPI projects.
+
+## Install
+
+```bash
+pip install .
+```
+
+Or from a Git repository:
+
+```bash
+pip install git+https://github.com/<your-org>/<your-repo>.git
+```
+
+## Usage
+
+```python
+from fastapi import FastAPI
+from rapidoc_fastapi import mount_rapidoc
+
+app = FastAPI(docs_url=None, redoc_url=None)
+
+@app.get("/health")
+def health() -> dict[str, str]:
+    return {"status": "ok"}
+
+mount_rapidoc(app, docs_path="/docs", title="My API Docs")
+```
+
+## Router API
+
+```python
+from rapidoc_fastapi import create_rapidoc_router
+
+router = create_rapidoc_router(
+    docs_path="/docs",
+    openapi_url="/openapi.json",
+    title="My API Docs",
+)
+
+app.include_router(router)
+```
+
+## Notes
+
+- `docs_path` controls where RapiDoc UI is served.
+- `openapi_url` defaults to the app OpenAPI endpoint.
+- This package uses the official RapiDoc script from CDN by default.

fastapi_rapidoc_router-0.1.0/fastapi_rapidoc_router.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: fastapi-rapidoc-router
+Version: 0.1.0
+Summary: Simple reusable RapiDoc router for FastAPI OpenAPI specs
+Keywords: fastapi,rapidoc,openapi,docs
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Framework :: FastAPI
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: fastapi>=0.100.0
+
+# fastapi-rapidoc-router
+
+Simple reusable RapiDoc router for FastAPI projects.
+
+## Install
+
+```bash
+pip install .
+```
+
+Or from a Git repository:
+
+```bash
+pip install git+https://github.com/<your-org>/<your-repo>.git
+```
+
+## Usage
+
+```python
+from fastapi import FastAPI
+from rapidoc_fastapi import mount_rapidoc
+
+app = FastAPI(docs_url=None, redoc_url=None)
+
+@app.get("/health")
+def health() -> dict[str, str]:
+    return {"status": "ok"}
+
+mount_rapidoc(app, docs_path="/docs", title="My API Docs")
+```
+
+## Router API
+
+```python
+from rapidoc_fastapi import create_rapidoc_router
+
+router = create_rapidoc_router(
+    docs_path="/docs",
+    openapi_url="/openapi.json",
+    title="My API Docs",
+)
+
+app.include_router(router)
+```
+
+## Notes
+
+- `docs_path` controls where RapiDoc UI is served.
+- `openapi_url` defaults to the app OpenAPI endpoint.
+- This package uses the official RapiDoc script from CDN by default.

fastapi_rapidoc_router-0.1.0/fastapi_rapidoc_router.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+fastapi_rapidoc_router.egg-info/PKG-INFO
+fastapi_rapidoc_router.egg-info/SOURCES.txt
+fastapi_rapidoc_router.egg-info/dependency_links.txt
+fastapi_rapidoc_router.egg-info/requires.txt
+fastapi_rapidoc_router.egg-info/top_level.txt
+rapidoc_fastapi/__init__.py
+rapidoc_fastapi/router.py

fastapi_rapidoc_router-0.1.0/fastapi_rapidoc_router.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_rapidoc_router-0.1.0/fastapi_rapidoc_router.egg-info/requires.txt

@@ -0,0 +1 @@
+fastapi>=0.100.0

fastapi_rapidoc_router-0.1.0/fastapi_rapidoc_router.egg-info/top_level.txt

@@ -0,0 +1 @@
+rapidoc_fastapi

fastapi_rapidoc_router-0.1.0/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fastapi-rapidoc-router"
+version = "0.1.0"
+description = "Simple reusable RapiDoc router for FastAPI OpenAPI specs"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+  "fastapi>=0.100.0",
+]
+keywords = ["fastapi", "rapidoc", "openapi", "docs"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Framework :: FastAPI",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["rapidoc_fastapi*"]

fastapi_rapidoc_router-0.1.0/rapidoc_fastapi/__init__.py

@@ -0,0 +1,3 @@
+from .router import create_rapidoc_router, mount_rapidoc
+
+__all__ = ["create_rapidoc_router", "mount_rapidoc"]

fastapi_rapidoc_router-0.1.0/rapidoc_fastapi/router.py

@@ -0,0 +1,137 @@
+from __future__ import annotations
+
+from html import escape
+
+from fastapi import APIRouter, FastAPI
+from fastapi.responses import HTMLResponse
+
+RAPIDOC_JS_CDN = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
+DEFAULT_FAVICON = "https://ui-avatars.com/api/?name=RapiDoc&rounded=true"
+
+
+def _normalize_docs_path(docs_path: str) -> str:
+    if not docs_path:
+        raise ValueError("docs_path must be a non-empty string")
+
+    normalized = docs_path if docs_path.startswith("/") else f"/{docs_path}"
+    if normalized != "/":
+        normalized = normalized.rstrip("/")
+
+    return normalized
+
+
+def _render_rapidoc_html(
+    *,
+    title: str,
+    openapi_url: str,
+    rapidoc_js_url: str,
+    favicon_url: str,
+) -> str:
+    safe_title = escape(title)
+    safe_openapi_url = escape(openapi_url)
+    safe_rapidoc_js_url = escape(rapidoc_js_url)
+    safe_favicon = escape(favicon_url)
+
+    return f"""<!doctype html>
+<html>
+  <head>
+    <meta charset=\"utf-8\" />
+    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />
+    <script type=\"module\" src=\"{safe_rapidoc_js_url}\"></script>
+    <link rel=\"icon\" type=\"image/png\" href=\"{safe_favicon}\" />
+    <title>{safe_title}</title>
+    <style>
+      html,
+      body {{
+        width: 100%;
+        height: 100%;
+        margin: 0;
+        padding: 0;
+      }}
+
+      rapi-doc {{
+        height: 100%;
+        width: 100%;
+      }}
+    </style>
+  </head>
+  <body>
+    <rapi-doc
+      spec-url=\"{safe_openapi_url}\"
+      render-style=\"view\"
+      show-components=\"true\"
+      layout=\"row\"
+      allow-spec-url-load=\"false\"
+      allow-spec-file-load=\"false\"
+      default-schema-tab=\"schema\"
+      persist-auth=\"true\"
+      theme=\"dark\"
+      bg-color=\"#14191f\"
+      text-color=\"#aec2e0\"
+    ></rapi-doc>
+  </body>
+</html>
+"""
+
+
+def create_rapidoc_router(
+    *,
+    docs_path: str = "/docs",
+    openapi_url: str = "/openapi.json",
+    title: str = "API Documentation",
+    rapidoc_js_url: str = RAPIDOC_JS_CDN,
+    favicon_url: str = DEFAULT_FAVICON,
+) -> APIRouter:
+    """Create an APIRouter exposing a RapiDoc UI page."""
+    normalized_docs_path = _normalize_docs_path(docs_path)
+    router = APIRouter(tags=["docs"])
+
+    async def rapidoc_ui() -> HTMLResponse:
+        html = _render_rapidoc_html(
+            title=title,
+            openapi_url=openapi_url,
+            rapidoc_js_url=rapidoc_js_url,
+            favicon_url=favicon_url,
+        )
+        return HTMLResponse(content=html)
+
+    router.add_api_route(
+        path=normalized_docs_path,
+        endpoint=rapidoc_ui,
+        methods=["GET"],
+        include_in_schema=False,
+    )
+
+    # Support both /docs and /docs/ URLs.
+    if normalized_docs_path != "/":
+        router.add_api_route(
+            path=f"{normalized_docs_path}/",
+            endpoint=rapidoc_ui,
+            methods=["GET"],
+            include_in_schema=False,
+        )
+
+    return router
+
+
+def mount_rapidoc(
+    app: FastAPI,
+    *,
+    docs_path: str = "/docs",
+    openapi_url: str | None = None,
+    title: str = "API Documentation",
+    rapidoc_js_url: str = RAPIDOC_JS_CDN,
+    favicon_url: str = DEFAULT_FAVICON,
+) -> None:
+    """Attach a RapiDoc route to an existing FastAPI app."""
+    resolved_openapi_url = openapi_url or app.openapi_url or "/openapi.json"
+
+    app.include_router(
+        create_rapidoc_router(
+            docs_path=docs_path,
+            openapi_url=resolved_openapi_url,
+            title=title,
+            rapidoc_js_url=rapidoc_js_url,
+            favicon_url=favicon_url,
+        )
+    )

fastapi_rapidoc_router-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+