styling of swagger UI endpoint

Author: drkane

findthatpostcode/blueprints/__init__.py

@@ -1,5 +1,4 @@
-from fastapi import APIRouter, FastAPI, Request
-from fastapi.middleware.cors import CORSMiddleware
+from fastapi import APIRouter, Request
 
 from findthatpostcode.blueprints import (
     addtocsv,
@@ -16,19 +15,7 @@
 from findthatpostcode.db import ElasticsearchDep
 from findthatpostcode.utils import templates
 
-app = FastAPI(
-    docs_url=None,
-    redoc_url=None,
-)
-
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=["*"],
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-    expose_headers=["Content-Disposition"],
-)
+app = APIRouter()
 
 
 @app.get("/")

findthatpostcode/blueprints/areas.py

@@ -54,7 +54,7 @@ def areas_csv(areas: Iterator[dict], filename: str) -> Response:
 
 
 @bp.get("/{areacodes}.geojson")
-@api.get("/{areacodes}.geojson")
+@api.get("/{areacodes}.geojson", name="legacy_get_area_boundary")
 def get_area_boundary(areacodes: str, es: ElasticsearchDep, s3_client: S3Dep):
     areacode_list: list[str] = areacodes.split("+")
     features = []
@@ -69,7 +69,7 @@ def get_area_boundary(areacodes: str, es: ElasticsearchDep, s3_client: S3Dep):
 
 
 @bp.get("/{areacode}/children/{areatype}.geojson")
-@api.get("/{areacode}/children/{areatype}.geojson")
+@api.get("/{areacode}/children/{areatype}.geojson", include_in_schema=False)
 def get_area_children_boundary(
     areacode: str, areatype: str, es: ElasticsearchDep, s3_client: S3Dep
 ):
@@ -92,7 +92,7 @@ def get_area_children_boundary(
 
 @bp.get("/{areacode}")
 @bp.get("/{areacode}.{filetype}")
-@api.get("/{areacode}")
+@api.get("/{areacode}", name="legacy_get_area")
 def get_area(
     areacode: str,
     request: Request,

findthatpostcode/blueprints/areatypes.py

@@ -29,7 +29,7 @@ def all_areatypes(es: ElasticsearchDep, request: Request) -> Response:
 
 @bp.get("/{areacode}")
 @bp.get("/{areacode}.{filetype}")
-@api.get("/{areacode}")
+@api.get("/{areacode}", name="legacy_get_areatype")
 def get_areatype(
     areacode: str,
     request: Request,

findthatpostcode/blueprints/places.py

@@ -20,7 +20,7 @@ def point_redirect(lat: float, lon: float, request: Request) -> Response:
 
 @bp.get("/nearest/{lat},{lon}")
 @bp.get("/nearest/{lat},{lon}.{filetype}")
-@api.get("/nearest/{lat},{lon}")
+@api.get("/nearest/{lat},{lon}", include_in_schema=False)
 def nearest(
     lat: float, lon: float, es: ElasticsearchDep, filetype: str = "json"
 ) -> Response:
@@ -43,7 +43,7 @@ def nearest(
 
 @bp.get("/{areacode}")
 @bp.get("/{areacode}.{filetype}")
-@api.get("/{areacode}")
+@api.get("/{areacode}", name="legacy_get_place")
 def get_place(
     areacode: str, es: ElasticsearchDep, request: Request, filetype: str = "json"
 ):

findthatpostcode/blueprints/points.py

@@ -22,7 +22,7 @@ def point_redirect(lat: float, lon: float, request: Request) -> Response:
 
 
 @bp.get("/{latlon}")
-@api.get("/{latlon}")
+@api.get("/{latlon}", name="legacy_get_point")
 def get_point(latlon: str, es: ElasticsearchDep, request: Request):
     filetype = "json"
     if latlon.endswith(".json"):

findthatpostcode/blueprints/postcodes.py

@@ -30,7 +30,7 @@ def postcode_redirect(postcode: str, request: Request) -> Response:
 
 @bp.get("/{postcode}")
 @bp.get("/{postcode}.{filetype}")
-@api.get("/{postcode}")
+@api.get("/{postcode}", name="legacy_get_postcode")
 def get_postcode(
     postcode: str, request: Request, es: ElasticsearchDep, filetype: str = "json"
 ):
@@ -42,7 +42,7 @@ def get_postcode(
 
 @bp.get("/hash/{hash_}")
 @bp.get("/hash/{hash_}.json")
-@api.get("/hash/{hash_}")
+@api.get("/hash/{hash_}", include_in_schema=False)
 def single_hash(
     hash_: str,
     properties: Annotated[list[str], Query()],
@@ -54,7 +54,7 @@ def single_hash(
 
 @bp.get("/hashes")
 @bp.get("/hashes.json")
-@api.get("/hashes")
+@api.get("/hashes", include_in_schema=False)
 def multi_hash_get(
     hash: Annotated[str | list[str], Query()],
     properties: Annotated[list[str], Query()],
@@ -66,7 +66,7 @@ def multi_hash_get(
 
 @bp.post("/hashes")
 @bp.post("/hashes.json")
-@api.post("/hashes")
+@api.post("/hashes", include_in_schema=False)
 def multi_hash_post(
     hash: Annotated[str | list[str], Form()],
     properties: Annotated[list[str], Form()],

findthatpostcode/blueprints/reconcile.py

@@ -54,7 +54,7 @@ class ReconcileRequest(BaseModel):
 
 
 @bp.get("/")
-@api.get("/")
+@api.get("/", include_in_schema=False)
 def reconcile_get(
     es: ElasticsearchDep,
     extend: Annotated[str | None, Query()] = None,
@@ -65,7 +65,7 @@ def reconcile_get(
 
 
 @bp.post("/")
-@api.post("/")
+@api.post("/", include_in_schema=False)
 def reconcile_post(
     es: ElasticsearchDep,
     extend: Annotated[str | None, Form()] = None,

findthatpostcode/main.py

@@ -1,6 +1,13 @@
+import os
+
 import sentry_sdk
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
+from fastapi.openapi.docs import (
+    get_swagger_ui_html,
+    get_swagger_ui_oauth2_redirect_html,
+)
+from fastapi.responses import FileResponse
 from fastapi.staticfiles import StaticFiles
 from sentry_sdk.integrations.fastapi import FastApiIntegration
 
@@ -23,11 +30,11 @@
     title="Find that Postcode",
     version="2.0",
     description="""
-This site presents data on UK postcodes and geographical areas, based on open data released by
+This API presents data on UK postcodes and geographical areas, based on open data released by
 the [Office for National Statistics](https://geoportal.statistics.gov.uk/) and
 [Ordnance Survey](https://osdatahub.os.uk/).
 """,
-    docs_url="/api/docs",
+    docs_url=None,
     redoc_url=None,
     openapi_url="/api/openapi.json",
     openapi_tags=[
@@ -41,14 +48,16 @@
         },
     ],
     contact={
-        "name": "Kane Data Ltd",
-        "url": "https://kanedata.co.uk",
+        "name": "Find that Postcode",
+        "url": "https://findthatpostcode.uk",
         "email": "info@findthatpostcode.uk",
     },
-    license_info={
-        "name": "TBD",
-        # "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
-    },
+    # license_info={
+    #     "name": "TBD",
+    #     # "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+    # },  # @todo License?
+    swagger_js_url="/static/swagger-ui/swagger-ui-bundle.js",
+    swagger_css_url="/static/swagger-ui/swagger-ui.css",
 )
 
 
@@ -60,8 +69,9 @@
 
 app.include_router(legacy_router, prefix="/api/v1", deprecated=True)
 app.include_router(api_router, prefix="/api/v2")
-
-app.mount("/", legacy_app)  # Mount the legacy FastAPI app at the root
+app.include_router(
+    legacy_app, include_in_schema=False
+)  # Mount the legacy FastAPI app at the root
 
 app.add_middleware(
     CORSMiddleware,
@@ -71,3 +81,31 @@
     allow_headers=["*"],
     expose_headers=["Content-Disposition"],
 )
+
+
+@app.get("/favicon.ico", include_in_schema=False)
+async def favicon():
+    return FileResponse(os.path.join(STATIC_DIR, "images/favicon.ico"))
+
+
+@app.get("/api/docs", include_in_schema=False)
+async def custom_swagger_ui_html():
+    if app.openapi_url:
+        return get_swagger_ui_html(
+            openapi_url=app.openapi_url,
+            title=app.title + " - API Documentation",
+            oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
+            swagger_js_url="/static/lib/swagger-ui/swagger-ui-bundle.js",
+            swagger_css_url="/static/css/swagger-ui.css",
+            swagger_favicon_url="/favicon.ico",
+            swagger_ui_parameters={
+                "defaultModelsExpandDepth": 0,
+            },
+        )
+
+
+if app.swagger_ui_oauth2_redirect_url:
+
+    @app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
+    async def swagger_ui_redirect():
+        return get_swagger_ui_oauth2_redirect_html()