2 Commits

Author SHA1 Message Date
c95de5a6e9 bumped up version to 0.0.6 2026-07-19 20:20:42 +05:30
b3f3068f8d auth-fixes (#3)
## Summary

Resolve `{ENV_VAR}` placeholders in the OpenAPI spec before serving it. Replace the monolithic `x-introspect-url` extension with composable `x-server-url` + individual `x-*-path` fields so auth endpoints are configurable per-environment without hardcoding.

## Changes

- **`openapi_first/app.py`** — add `_resolve_spec_env_vars()` that replaces `{ENV_VAR}` patterns (e.g. `{AUTH_SERVER}`) with the corresponding OS environment variable before returning the spec JSON. Called in `__init__` after spec load.
- **`openapi_first/security.py`** — build the introspection URL dynamically from `x-server-url` + `x-introspect-path` extensions on the `bearerAuth` security scheme, instead of reading a single `x-introspect-url`.

## Migration

Existing specs using `x-introspect-url: "https://auth.example.com/introspect"` must switch to the new extension format:

```yaml
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      x-server-url: "{AUTH_SERVER}"
      x-login-path: "/login"
      x-register-path: "/register"
      x-logout-path: "/logout"
      x-me-path: "/me"
      x-introspect-path: "/introspect"

Reviewed-on: #3
Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
2026-07-19 14:47:02 +00:00
3 changed files with 29 additions and 3 deletions

View File

@@ -32,12 +32,35 @@ Notes:
- Alter FastAPI dependency injection semantics. - Alter FastAPI dependency injection semantics.
""" """
import os
import re
from fastapi import FastAPI from fastapi import FastAPI
from .binder import bind_routes from .binder import bind_routes
from .loader import load_openapi from .loader import load_openapi
from .security import make_security_dependencies, parse_security_schemes from .security import make_security_dependencies, parse_security_schemes
_env_pattern = re.compile(r"\{(\w+)\}")
def _resolve_env(value: str) -> str:
"""Replace {ENV_VAR} placeholders with values from os.environ."""
def _replace(m: re.Match) -> str:
return os.environ.get(m.group(1), m.group(0))
return _env_pattern.sub(_replace, value)
def _resolve_spec_env_vars(obj):
"""Recursively resolve {ENV_VAR} in all string values of the spec."""
if isinstance(obj, str):
return _resolve_env(obj)
if isinstance(obj, dict):
return {k: _resolve_spec_env_vars(v) for k, v in obj.items()}
if isinstance(obj, list):
return [_resolve_spec_env_vars(v) for v in obj]
return obj
class OpenAPIFirstApp(FastAPI): class OpenAPIFirstApp(FastAPI):
""" """
@@ -107,7 +130,7 @@ class OpenAPIFirstApp(FastAPI):
super().__init__(**fastapi_kwargs) super().__init__(**fastapi_kwargs)
# Load and validate OpenAPI specification # Load and validate OpenAPI specification
self._openapi_spec = load_openapi(openapi_path) self._openapi_spec = _resolve_spec_env_vars(load_openapi(openapi_path))
# Parse security schemes and build per-route dependencies # Parse security schemes and build per-route dependencies
security_schemes = parse_security_schemes(self._openapi_spec) security_schemes = parse_security_schemes(self._openapi_spec)

View File

@@ -97,7 +97,10 @@ def _build_dependency(scheme_name: str, scheme: dict) -> Callable | None:
scheme_type = scheme.get("type") scheme_type = scheme.get("type")
if scheme_type == "http" and scheme.get("scheme") == "bearer": if scheme_type == "http" and scheme.get("scheme") == "bearer":
return _make_bearer_dependency(scheme.get("x-introspect-url")) server_url = scheme.get("x-server-url", "")
introspect_path = scheme.get("x-introspect-path", "/introspect")
introspect_url = server_url + introspect_path if server_url else None
return _make_bearer_dependency(introspect_url)
return None return None

View File

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "openapi-first" name = "openapi-first"
version = "0.0.5" version = "0.0.6"
description = "Strict OpenAPI-first application bootstrap for FastAPI." description = "Strict OpenAPI-first application bootstrap for FastAPI."
readme = "README.md" readme = "README.md"
requires-python = ">=3.10" requires-python = ">=3.10"