Web Application Server (ixmp4.server)
Run the web api with:
ixmp4 server start [--host 127.0.0.1] [--port 9000]
This will start ixmp4’s asgi server. Check http://127.0.0.1:9000/docs/
for comprehensive openapi documentation.
- class ixmp4.server.ServerStatus(*, utcnow: datetime, manager_url: HttpUrl | None)
Bases:
BaseModel- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class ixmp4.server.ServerContoller(owner: Router)
Bases:
Controller- status = <litestar.handlers.http_handlers.decorators.get object>
- after_request
A sync or async function executed before a
Requestis passed to any route handler.If this function returns a value, the request will not reach the route handler, and instead this value will be used.
- after_response
A sync or async function called after the response has been awaited.
It receives the
Requestinstance and should not return any values.
- before_request
A sync or async function called immediately before calling the route handler.
It receives the
Requestinstance and any non-Nonereturn value is used for the response, bypassing the route handler.
- cache_control
A
CacheControlHeaderheader to add to route handlers of this controller.Can be overridden by route handlers.
- dependencies
A string keyed dictionary of dependency
Providerinstances.
- dto
AbstractDTOto use for (de)serializing and validation of request data.
- etag
An
etagheader of typeETagto add to route handlers of this controller.Can be overridden by route handlers.
- exception_handlers
A map of handler functions to status codes and/or exception types.
- guards
A sequence of
Guardcallables.
- include_in_schema
A boolean flag dictating whether the route handler should be documented in the OpenAPI schema
- middleware
A sequence of
Middleware.
- opt
A string key mapping of arbitrary values that can be accessed in
Guardsor wherever you have access toRequestorASGI Scope.
- owner
The
RouterorLitestarapp that owns the controller.This value is set internally by Litestar and it should not be set when subclassing the controller.
- parameters
A mapping of
Parameterdefinitions available to all application paths.
- path
A path fragment for the controller.
All route handlers under the controller will have the fragment appended to them. If not set it defaults to
/.
- request_class
A custom subclass of
Requestto be used as the default request for all route handlers under the controller.
- request_max_body_size
Maximum allowed size of the request body in bytes. If this size is exceeded, a ‘413 - Request Entity Too Large’ error response is returned.
- response_class
A custom subclass of
Responseto be used as the default response for all route handlers under the controller.
- response_cookies
A list of
Cookieinstances.
- response_headers
A string keyed dictionary mapping
ResponseHeaderinstances.
- return_dto
AbstractDTOto use for serializing outbound response data.
- security
A sequence of dictionaries that to the schema of all route handlers under the controller.
- signature_namespace
A mapping of names to types for use in forward reference resolution during signature modelling.
- signature_types
A sequence of types for use in forward reference resolution during signature modelling.
These types will be added to the signature namespace using their
__name__attribute.
- tags
A sequence of string tags that will be appended to the schema of all route handlers under the controller.
- type_decoders
A sequence of tuples, each composed of a predicate testing for type identity and a msgspec hook for deserialization.
- type_encoders
A mapping of types to callables that transform them into types supported for serialization.
- websocket_class
A custom subclass of
WebSocketto be used as the default websocket for all route handlers under the controller.
- class ixmp4.server.Ixmp4Server(settings: ServerSettings, debug: bool = False, override_transport: Callable[..., Awaitable[DirectTransport]] | None = None, **kwargs: Any)
Bases:
object- settings: ServerSettings
- asgi_app: Litestar