Server
This class represents a server definition, typically used for defining base URLs in API specifications. It includes the server's URL, an optional description, and a dictionary of variables for template substitution within the URL.
Attributes
| Attribute | Type | Description |
|---|---|---|
| url | `AnyUrl | str` |
| description | `str | None` = null |
| variables | `dict[str, ServerVariable] | None` = null |
Constructor
Signature
def Server(
url: AnyUrl | str,
description: str | None = None,
variables: dict[str, [ServerVariable](servervariable.md?sid=fastapi_openapi_models_servervariable)]| None = None
) - > null
Parameters
| Name | Type | Description |
|---|---|---|
| url | `AnyUrl | str` |
| description | `str | None` = None |
| variables | `dict[str, ServerVariable] | None` = None |
Signature
def Server(
url: AnyUrl | str,
description: str | None = None,
variables: dict[str, [ServerVariable](servervariable.md?sid=fastapi_openapi_models_servervariable)]| None = None
) - > null
Parameters
| Name | Type | Description |
|---|---|---|
| url | `AnyUrl | str` |
| description | `str | None` = None |
| variables | `dict[str, ServerVariable] | None` = None |