factor util endpoints out to dedicated router

molviewspec/app/api/examples.py

@@ -1,18 +1,13 @@
-import inspect
 import math
 from typing import Literal, TypeAlias
 
 import requests
 from fastapi import APIRouter
 from fastapi.responses import FileResponse, JSONResponse, PlainTextResponse, Response
-from pydantic import BaseModel, ValidationError
 
-import molviewspec
 from app.config import settings
 from molviewspec.builder import Representation, Root
 from molviewspec.nodes import ComponentExpression
-from molviewspec.nodes import validate_state_tree as validate_state_tree_internal
-from molviewspec.utils import get_major_version_tag
 
 MVSResponse: TypeAlias = Response
 """Response containing a MVS tree (as JSON)"""
@@ -304,36 +299,6 @@ async def validation_data(id: str) -> Response:
     return JSONResponse(transformed_data)
 
 
-# Create a custom endpoint to serve the OpenAPI JSON for your Pydantic models
-@router.get("/models/openapi.json")
-async def models_openapi() -> JSONResponse:
-    openapi_models = {}
-
-    # collect relevant impls
-    for name, clazz in inspect.getmembers(molviewspec.nodes) + inspect.getmembers(molviewspec.builder):
-        # TODO suppress 'private' classes?
-        if inspect.isclass(clazz) and issubclass(clazz, BaseModel) and clazz != BaseModel:
-            openapi_models[clazz.__name__] = clazz.schema()
-
-    openapi_spec = {
-        "openapi": "3.0.0",
-        "info": {"title": "MolViewSpec Node Schema OpenAPI", "version": get_major_version_tag()},
-        "paths": {},
-        "components": {"schemas": openapi_models},
-    }
-
-    return JSONResponse(content=openapi_spec)
-
-
-@router.get("/validate-state-tree")
-async def validate_state_tree(json: str) -> Response:
-    try:
-        validate_state_tree_internal(json)
-        return JSONResponse({"valid": True})
-    except ValidationError as e:
-        return JSONResponse(status_code=422, content=e.json())
-
-
 ##############################################################################
 # Examples for frontend testing
 

molviewspec/app/api/utils.py

@@ -0,0 +1,41 @@
+import inspect
+
+from fastapi import APIRouter
+from fastapi.responses import JSONResponse, Response
+from pydantic import BaseModel, ValidationError
+
+import molviewspec
+from molviewspec.nodes import validate_state_tree as validate_state_tree_internal
+from molviewspec.utils import get_major_version_tag
+
+router = APIRouter()
+
+
+# Create a custom endpoint to serve the OpenAPI JSON for your Pydantic models
+@router.get("/models/openapi.json")
+async def models_openapi() -> JSONResponse:
+    openapi_models = {}
+
+    # collect relevant impls
+    for name, clazz in inspect.getmembers(molviewspec.nodes) + inspect.getmembers(molviewspec.builder):
+        # TODO suppress 'private' classes?
+        if inspect.isclass(clazz) and issubclass(clazz, BaseModel) and clazz != BaseModel:
+            openapi_models[clazz.__name__] = clazz.schema()
+
+    openapi_spec = {
+        "openapi": "3.0.0",
+        "info": {"title": "MolViewSpec Node Schema OpenAPI", "version": get_major_version_tag()},
+        "paths": {},
+        "components": {"schemas": openapi_models},
+    }
+
+    return JSONResponse(content=openapi_spec)
+
+
+@router.get("/validate-state-tree")
+async def validate_state_tree(json: str) -> Response:
+    try:
+        validate_state_tree_internal(json)
+        return JSONResponse({"valid": True})
+    except ValidationError as e:
+        return JSONResponse(status_code=422, content=e.json())

molviewspec/app/main.py

@@ -3,9 +3,11 @@
 from fastapi.middleware.gzip import GZipMiddleware
 
 from app.api.examples import router as examples_router
+from app.api.utils import router as utils_router
 
 router = APIRouter()
 router.include_router(examples_router, prefix="/examples")
+router.include_router(utils_router, prefix="/utils")
 
 
 app = FastAPI(