Add legacy API

Author: drkane

findthatpostcode/blueprints/__init__.py

@@ -1,4 +1,4 @@
-from fastapi import FastAPI, Request
+from fastapi import APIRouter, FastAPI, Request
 from fastapi.middleware.cors import CORSMiddleware
 
 from findthatpostcode.blueprints import (
@@ -65,3 +65,13 @@ def about(request: Request):
 app.include_router(reconcile.bp)
 app.include_router(search.bp)
 app.include_router(tools.bp)
+
+
+api = APIRouter(tags=["Legacy"])
+
+api.include_router(areas.api)
+api.include_router(areatypes.api)
+api.include_router(places.api)
+api.include_router(points.api)
+api.include_router(postcodes.api)
+api.include_router(reconcile.api)

findthatpostcode/blueprints/areas.py

@@ -13,6 +13,8 @@
 
 bp = APIRouter(prefix="/areas")
 
+api = APIRouter(prefix="/areas")
+
 
 @bp.get("/search")
 @bp.get("/search.<filetype>")
@@ -52,6 +54,7 @@ def areas_csv(areas: Iterator[dict], filename: str) -> Response:
 
 
 @bp.get("/{areacodes}.geojson")
+@api.get("/{areacodes}.geojson")
 def get_area_boundary(areacodes: str, es: ElasticsearchDep, s3_client: S3Dep):
     areacode_list: list[str] = areacodes.split("+")
     features = []
@@ -66,6 +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")
 def get_area_children_boundary(
     areacode: str, areatype: str, es: ElasticsearchDep, s3_client: S3Dep
 ):
@@ -88,6 +92,7 @@ def get_area_children_boundary(
 
 @bp.get("/{areacode}")
 @bp.get("/{areacode}.{filetype}")
+@api.get("/{areacode}")
 def get_area(
     areacode: str,
     request: Request,

findthatpostcode/blueprints/areatypes.py

@@ -13,6 +13,8 @@
 
 bp = APIRouter(prefix="/areatypes")
 
+api = APIRouter(prefix="/areatypes")
+
 
 @bp.get("/")
 def all_areatypes(es: ElasticsearchDep, request: Request) -> Response:
@@ -27,6 +29,7 @@ def all_areatypes(es: ElasticsearchDep, request: Request) -> Response:
 
 @bp.get("/{areacode}")
 @bp.get("/{areacode}.{filetype}")
+@api.get("/{areacode}")
 def get_areatype(
     areacode: str,
     request: Request,

findthatpostcode/blueprints/places.py

@@ -7,6 +7,8 @@
 
 bp = APIRouter(prefix="/places")
 
+api = APIRouter(prefix="/places")
+
 
 @bp.get("/redirect")
 def point_redirect(lat: float, lon: float, request: Request) -> Response:
@@ -18,6 +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}")
 def nearest(
     lat: float, lon: float, es: ElasticsearchDep, filetype: str = "json"
 ) -> Response:
@@ -40,6 +43,7 @@ def nearest(
 
 @bp.get("/{areacode}")
 @bp.get("/{areacode}.{filetype}")
+@api.get("/{areacode}")
 def get_place(
     areacode: str, es: ElasticsearchDep, request: Request, filetype: str = "json"
 ):

findthatpostcode/blueprints/points.py

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

findthatpostcode/blueprints/postcodes.py

@@ -17,6 +17,8 @@
 
 bp = APIRouter(prefix="/postcodes")
 
+api = APIRouter(prefix="/postcodes")
+
 
 @bp.get("/redirect")
 def postcode_redirect(postcode: str, request: Request) -> Response:
@@ -28,6 +30,7 @@ def postcode_redirect(postcode: str, request: Request) -> Response:
 
 @bp.get("/{postcode}")
 @bp.get("/{postcode}.{filetype}")
+@api.get("/{postcode}")
 def get_postcode(
     postcode: str, request: Request, es: ElasticsearchDep, filetype: str = "json"
 ):
@@ -39,6 +42,7 @@ def get_postcode(
 
 @bp.get("/hash/{hash_}")
 @bp.get("/hash/{hash_}.json")
+@api.get("/hash/{hash_}")
 def single_hash(
     hash_: str,
     properties: Annotated[list[str], Query()],
@@ -48,7 +52,9 @@ def single_hash(
     return JSONResponse({"data": get_postcode_by_hash(es, hash_, properties)})
 
 
+@bp.get("/hashes")
 @bp.get("/hashes.json")
+@api.get("/hashes")
 def multi_hash_get(
     hash: Annotated[str | list[str], Query()],
     properties: Annotated[list[str], Query()],
@@ -58,7 +64,9 @@ def multi_hash_get(
     return JSONResponse({"data": get_postcode_by_hash(es, hash, properties)})
 
 
+@bp.post("/hashes")
 @bp.post("/hashes.json")
+@api.post("/hashes")
 def multi_hash_post(
     hash: Annotated[str | list[str], Form()],
     properties: Annotated[list[str], Form()],

findthatpostcode/blueprints/reconcile.py

@@ -14,6 +14,8 @@
 
 bp = APIRouter(prefix="/reconcile")
 
+api = APIRouter(prefix="/reconcile")
+
 
 def recon_query(q, es, p: int = 1, size: int = 10):
     result = []
@@ -33,7 +35,7 @@ def recon_query(q, es, p: int = 1, size: int = 10):
     elif query:
         pagination = Pagination(page=p, size=size)
         areas = search_areas(query, es, pagination=pagination)
-        for a, score in zip(areas["result"], areas["scores"]):
+        for a, score in zip(areas["result"], areas["scores"]):  # type: ignore
             result.append(
                 {
                     "id": a.id,
@@ -52,19 +54,21 @@ class ReconcileRequest(BaseModel):
 
 
 @bp.get("/")
+@api.get("/")
 def reconcile_get(
     es: ElasticsearchDep,
-    extend: Annotated[str, Query()] = None,
+    extend: Annotated[str | None, Query()] = None,
     queries: Annotated[str | None, Query()] = None,
     callback: str | None = None,
 ):
     return do_reconcile(es, extend, queries, callback)
 
 
 @bp.post("/")
+@api.post("/")
 def reconcile_post(
     es: ElasticsearchDep,
-    extend: Annotated[str, Form()] = None,
+    extend: Annotated[str | None, Form()] = None,
     queries: Annotated[str | None, Form()] = None,
     callback: Annotated[str | None, Query()] = None,
 ):

findthatpostcode/blueprints/search.py

@@ -49,7 +49,8 @@ def search_index(
     if latlon:
         return RedirectResponse(
             request.url_for(
-                "get_point", latlon="{},{}.html".format(latlon["lat"], latlon["lon"])
+                "get_point",
+                latlon="{},{}.html".format(latlon["lat"], latlon["lon"]),  # type: ignore
             ),
             status_code=303,
         )
@@ -66,8 +67,8 @@ def search_index(
         es,
         pagination=pagination,
     )
-    result = zip(areas["result"], areas["scores"])
-    pagination.set_pagination(areas["result_count"])
+    result = zip(areas["result"], areas["scores"])  # type: ignore
+    pagination.set_pagination(areas["result_count"])  # type: ignore
     nav = {
         p: request.url_for("search_index").include_query_params(q=q, **args)
         if isinstance(args, dict)

findthatpostcode/main.py

@@ -4,9 +4,9 @@
 from fastapi.staticfiles import StaticFiles
 from sentry_sdk.integrations.fastapi import FastApiIntegration
 
+from findthatpostcode.blueprints import api as legacy_router
 from findthatpostcode.blueprints import app as legacy_app
 from findthatpostcode.routers import router as api_router
-from findthatpostcode.routers.legacy import router as legacy_router
 from findthatpostcode.settings import ENVIRONMENT, SENTRY_DSN, STATIC_DIR
 
 if SENTRY_DSN:
@@ -19,7 +19,15 @@
     )
 
 
-app = FastAPI()
+app = FastAPI(
+    title="Find that Postcode",
+    version="2.0",
+    description="""
+This site 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/).
+""",
+)
 
 
 app.mount(
@@ -35,8 +43,9 @@
 
 app.add_middleware(
     CORSMiddleware,
-    # allow_origins=["*"],
-    # allow_credentials=True,
-    # allow_methods=["*"],
-    # allow_headers=["*"],
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+    expose_headers=["Content-Disposition"],
 )

findthatpostcode/routers/__init__.py

@@ -4,4 +4,4 @@
 
 router = APIRouter()
 
-router.include_router(postcodes_router, prefix="/postcodes", tags=["postcodes"])
+router.include_router(postcodes_router, prefix="/postcodes")