vipr.plugins.api.fastapi package

Subpackages

• vipr.plugins.api.fastapi.router_generator package
  • Submodules
  • vipr.plugins.api.fastapi.router_generator.constants module
  • vipr.plugins.api.fastapi.router_generator.core module
    • create_temp_yaml()
    • create_typed_parameter()
    • execute_cli_command()
    • extract_query_params_from_ex()
    • get_current_timestamp()
    • handle_uuid_validation()
    • process_result()
    • python_method_to_cli_command()
    • resolve_model_type()
    • serialize_numpy_data()
    • validate_cli_argument()
  • vipr.plugins.api.fastapi.router_generator.endpoints module
    • create_get_endpoint_with_params()
    • create_plugin_safe_endpoint()
    • create_post_endpoint()
    • create_simple_get_endpoint()
  • vipr.plugins.api.fastapi.router_generator.router_generator module
    • build_router()
    • discover_plugin_apis()
  • vipr.plugins.api.fastapi.router_generator.security module
    • ParamValidator
      • ParamValidator.validate_and_sanitize()
  • Module contents
    • build_router()
    • discover_plugin_apis()

Submodules

vipr.plugins.api.fastapi.debug module

Debug Router for Plugin API Mappings

Provides endpoints to inspect auto-generated API mappings.

async vipr.plugins.api.fastapi.debug.get_api_mapping() → list[dict[str, Any]]

Shows all Plugin → API mappings for debugging and documentation.

Returns:

List of all HTTP ↔ CLI command mappings

async vipr.plugins.api.fastapi.debug.get_plugin_status() → dict[str, Any]

Shows the status of the plugin introspection system.

Returns:

Status information about plugin discovery

Module contents

FastAPI Integration for VIPR Framework

Provides automatic FastAPI router generation from Cement CLI controllers.

class vipr.plugins.api.fastapi.ParamValidator

Bases: object

classmethod validate_and_sanitize(value: Any, param_type: str = 'str') → str

Validate and sanitize parameter value.

vipr.plugins.api.fastapi.build_router() → APIRouter

Build FastAPI router by scanning controller methods for @api decorators.

This function introspects all loaded Cement controllers for methods decorated with @api and automatically generates corresponding FastAPI endpoints. All methods are executed via runner.run_controller() to ensure proper plugin initialization.

Returns:

APIRouter with auto-generated endpoints

vipr.plugins.api.fastapi.discover_plugin_apis() → list[dict[str, Any]]

Discover all plugin APIs for debugging and documentation.

Scans all controllers for @api decorator-based endpoints.

Returns:

List of API endpoint mappings