apifrom.core

Core functionality for the APIFromAnything library.

This module contains the core components for the API framework, including the application container, routing mechanism, request handling, and response handling.

Overview

Classes

• API

• Request

• Response

• Router

Classes

class apifrom.core.API(debug=False, title='APIFromAnything API', description='API created with APIFromAnything', version='1.0.0', docs_url='/docs', openapi_config=None, swagger_ui_config=None, enable_docs=True)

Parameters:

• debug (bool)

• title (str)

• description (str)

• version (str)

• docs_url (str)

• openapi_config (apifrom.docs.openapi.OpenAPIConfig | None)

• swagger_ui_config (apifrom.docs.swagger_ui.SwaggerUIConfig | None)

• enable_docs (bool)

Main application container for APIFromAnything.

This class serves as the central registry for all API endpoints, middleware, and configuration. It provides methods for registering endpoints, middleware, and starting the server.

apifrom.core.router

The router instance for managing routes.

Type:

Router

apifrom.core.middleware

List of middleware instances.

Type:

list

apifrom.core.debug

Whether to run in debug mode.

Type:

bool

apifrom.core.title

The title of the API.

Type:

str

apifrom.core.description

The description of the API.

Type:

str

apifrom.core.version

The version of the API.

Type:

str

apifrom.core.docs_url

The URL for the API documentation.

Type:

str

Initialize a new API instance.

param debug:

Whether to run in debug mode.

param title:

The title of the API.

param description:

The description of the API.

param version:

The version of the API.

param docs_url:

The URL for the API documentation.

param openapi_config:

Configuration for OpenAPI documentation.

param swagger_ui_config:

Configuration for Swagger UI.

param enable_docs:

Whether to enable API documentation.

apifrom.core.__call__(scope, receive, send)

ASGI callable.

This method allows the API instance to be used as an ASGI application.

param scope:

The ASGI scope.

param receive:

The ASGI receive function.

param send:

The ASGI send function.

apifrom.core._build_app()

Build the Starlette application.

returns:

The Starlette application instance.

apifrom.core._get_current_instance()

:classmethod:

Get the current API instance.

returns:

The current API instance, or None if no instance has been created.

apifrom.core.add_middleware(middleware)

Add middleware to the API.

param middleware:

The middleware instance to add.

apifrom.core.add_route(path, endpoint=None, methods=None, name=None, include_in_schema=True, **kwargs)

Add a route to the API.

This method can be used as a decorator or called directly.

param path:

The path for the route.

param endpoint:

The endpoint function.

param methods:

The HTTP methods for the route.

param name:

The name for the route.

param include_in_schema:

Whether to include the route in the OpenAPI schema.

param **kwargs:

Additional arguments to pass to the router.

returns:

The endpoint function if used as a decorator, or None if called directly.

apifrom.core.add_routes(routes)

Add multiple routes to the API.

This method adds multiple routes to the API at once. The routes should be functions decorated with the @api decorator.

param routes:

A list of functions decorated with the @api decorator.

apifrom.core.process_request(request)

:async:

Process a request and return a response.

This method is used by adapters to process requests without going through the ASGI interface.

param request:

The request to process.

returns:

The response to the request.

apifrom.core.register_endpoint(handler, route, method='GET', name=None, **kwargs)

Register an endpoint with the API.

param handler:

The handler function for the endpoint.

param route:

The route for the endpoint.

param method:

The HTTP method for the endpoint.

param name:

The name of the endpoint.

param **kwargs:

Additional arguments to pass to the router.

apifrom.core.run(host='127.0.0.1', port=8000, **kwargs)

Run the API server.

param host:

The host to bind to.

param port:

The port to bind to.

param **kwargs:

Additional arguments to pass to uvicorn.run.

class apifrom.core.Request(request=None, path_params=None, method=None, path=None, query_params=None, headers=None, body=None, client_ip=None)

Parameters:

• request (Optional[starlette.requests.Request])

• path_params (Optional[dict[Any, Any]])

• method (Optional[str])

• path (Optional[str])

• query_params (Optional[dict[Any, Any]])

• headers (Optional[dict[Any, Any]])

• body (Optional[Union[str, bytes]])

• client_ip (Optional[str])

Request class for APIFromAnything.

This class wraps a Starlette request and provides methods for accessing request data in a convenient way.

apifrom.core._request

The underlying Starlette request.

apifrom.core.path_params

Path parameters extracted from the URL.

apifrom.core.query_params

Query parameters extracted from the URL.

apifrom.core.headers

HTTP headers.

apifrom.core.method

HTTP method.

apifrom.core.path

Request path.

apifrom.core._body

Cached request body.

Initialize a new Request instance.

param request:

The underlying Starlette request.

param path_params:

Path parameters extracted from the URL.

param method:

The HTTP method.

param path:

The request path.

param query_params:

Query parameters.

param headers:

HTTP headers.

param body:

Request body.

param client_ip:

Client IP address.

apifrom.core.__getattr__(name)

Get an attribute from the underlying request.

param name:

The name of the attribute.

returns:

The attribute value.

raises AttributeError:

If the attribute is not found.

apifrom.core.body()

:async:

Get the request body.

returns:

The request body as bytes.

apifrom.core.form()

:async:

Get the request body as form data.

returns:

The request body parsed as form data.

apifrom.core.get_param(name, default=None)

Get a parameter from the request.

This method looks for the parameter in path parameters, query parameters, and then the request body (in that order).

param name:

The name of the parameter.

param default:

The default value to return if the parameter is not found.

returns:

The parameter value, or the default value if not found.

apifrom.core.json()

:async:

Get the request body as JSON.

returns:

The request body parsed as JSON.

raises ValueError:

If the request body is not valid JSON.

class apifrom.core.Response(content=None, status_code=200, headers=None, content_type='application/json')

Parameters:

• content (Any)

• status_code (int)

• headers (Optional[Dict[str, str]])

• content_type (str)

Response class for APIFromAnything.

This class represents an HTTP response and provides methods for setting response data, status code, and headers.

apifrom.core.content

The response content.

apifrom.core.status_code

The HTTP status code.

apifrom.core.headers

HTTP headers.

apifrom.core.content_type

The content type of the response.

Initialize a new Response instance.

param content:

The response content.

param status_code:

The HTTP status code.

param headers:

HTTP headers.

param content_type:

The content type of the response.

apifrom.core.from_dict(data)

:classmethod:

Create a Response instance from a dictionary.

param data:

The dictionary containing response data.

returns:

A new Response instance.

apifrom.core.set_cookie(key, value='', max_age=None, expires=None, path='/', domain=None, secure=False, httponly=False, samesite='lax')

Set a cookie in the response.

param key:

The cookie name.

param value:

The cookie value.

param max_age:

The maximum age of the cookie in seconds.

param expires:

The expiration time of the cookie as a UNIX timestamp.

param path:

The path for which the cookie is valid.

param domain:

The domain for which the cookie is valid.

param secure:

Whether the cookie should only be sent over HTTPS.

param httponly:

Whether the cookie should be accessible only via HTTP.

param samesite:

The SameSite attribute of the cookie.

apifrom.core.to_dict()

Convert the response to a dictionary.

returns:

A dictionary representation of the response.

apifrom.core.to_starlette_response()

Convert to a Starlette response.

returns:

A Starlette response.

class apifrom.core.Router

Router for managing API endpoints.

This class is responsible for registering and looking up API endpoints. It maintains a registry of routes and their associated handlers.

apifrom.core.routes

List of registered routes.

Type:

list

Initialize a new Router instance.

apifrom.core.add_route(handler, path=None, method='GET', name=None, **kwargs)

Add a route to the router.

param handler:

The function to handle the route.

param path:

The URL path for the route. If None, derived from handler name.

param method:

The HTTP method for the route.

param name:

The name for the route. If None, derived from handler name.

param **kwargs:

Additional arguments to associate with the route.

apifrom.core.get_route_by_path(path, method='GET')

Get a route by path and method.

param path:

The path to match.

param method:

The HTTP method to match.

returns:

The route info if found, None otherwise.

apifrom.core.get_route_handler(path, method='GET')

Get a route handler by path and method.

param path:

The path to match.

param method:

The HTTP method to match.

returns:

The handler function if found, None otherwise.