mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-14 17:49:11 +02:00
118 lines
3.9 KiB
Text
118 lines
3.9 KiB
Text
---
|
|
title: openapi
|
|
sidebarTitle: openapi
|
|
---
|
|
|
|
# `fastmcp.utilities.openapi`
|
|
|
|
## Functions
|
|
|
|
### `parse_openapi_to_http_routes` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L112"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
```python
|
|
parse_openapi_to_http_routes(openapi_dict: dict[str, Any]) -> list[HTTPRoute]
|
|
```
|
|
|
|
|
|
Parses an OpenAPI schema dictionary into a list of HTTPRoute objects
|
|
using the openapi-pydantic library.
|
|
|
|
Supports both OpenAPI 3.0.x and 3.1.x versions.
|
|
|
|
|
|
### `clean_schema_for_display` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L570"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
```python
|
|
clean_schema_for_display(schema: JsonSchema | None) -> JsonSchema | None
|
|
```
|
|
|
|
|
|
Clean up a schema dictionary for display by removing internal/complex fields.
|
|
|
|
|
|
### `generate_example_from_schema` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L630"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
```python
|
|
generate_example_from_schema(schema: JsonSchema | None) -> Any
|
|
```
|
|
|
|
|
|
Generate a simple example value from a JSON schema dictionary.
|
|
Very basic implementation focusing on types.
|
|
|
|
|
|
### `format_json_for_description` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L713"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
```python
|
|
format_json_for_description(data: Any, indent: int = 2) -> str
|
|
```
|
|
|
|
|
|
Formats Python data as a JSON string block for markdown.
|
|
|
|
|
|
### `format_description_with_responses` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L722"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
```python
|
|
format_description_with_responses(base_description: str, responses: dict[str, Any], parameters: list[ParameterInfo] | None = None, request_body: RequestBodyInfo | None = None) -> str
|
|
```
|
|
|
|
|
|
Formats the base description string with response, parameter, and request body information.
|
|
|
|
**Args:**
|
|
- `base_description`: The initial description to be formatted.
|
|
- `responses`: A dictionary of response information, keyed by status code.
|
|
- `parameters`: A list of parameter information,
|
|
including path and query parameters. Each parameter includes details such as name,
|
|
location, whether it is required, and a description.
|
|
- `request_body`: Information about the request body,
|
|
including its description, whether it is required, and its content schema.
|
|
|
|
**Returns:**
|
|
- The formatted description string with additional details about responses, parameters,
|
|
- and the request body.
|
|
|
|
|
|
## Classes
|
|
|
|
### `ParameterInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L42"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
|
|
Represents a single parameter for an HTTP operation in our IR.
|
|
|
|
|
|
### `RequestBodyInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L52"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
|
|
Represents the request body for an HTTP operation in our IR.
|
|
|
|
|
|
### `ResponseInfo` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L62"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
|
|
Represents response information in our IR.
|
|
|
|
|
|
### `HTTPRoute` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L70"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
|
|
Intermediate Representation for a single OpenAPI operation.
|
|
|
|
|
|
### `OpenAPIParser` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L164"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
|
|
Unified parser for OpenAPI schemas with generic type parameters to handle both 3.0 and 3.1.
|
|
|
|
|
|
**Methods:**
|
|
|
|
#### `parse` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/utilities/openapi.py#L469"><Icon icon="github" size="14" /></a></sup>
|
|
|
|
```python
|
|
parse(self) -> list[HTTPRoute]
|
|
```
|
|
|
|
Parse the OpenAPI schema into HTTP routes.
|
|
|