langchain_community.utilities.openapi.OpenAPISpec

class langchain_community.utilities.openapi.OpenAPISpec

移除规范中格式不正确的部分的OpenAPI模型。

属性

base_url	获取基本URL。
openapi

方法

__init__()
from_file(path)	从文件路径获取OpenAPI规范。
from_spec_dict(spec_dict)	从字典获取OpenAPI规范。
from_text(text)	从文本获取OpenAPI规范。
from_url(url)	从URL获取OpenAPI规范。
get_cleaned_operation_id(operation, path, method)	从操作ID获取一个清洗后的操作ID。
get_methods_for_path(path)	返回指定路径的有效方法列表。
get_operation(path, method)	获取给定路径和HTTP方法的操作对象。
get_parameters_for_operation(operation)	获取给定操作的结构。
get_parameters_for_path(path)
get_referenced_schema(ref)	获取模式（或嵌套引用）或错误。
get_request_body_for_operation(operation)	获取给定操作的请求体。
get_schema(schema)
parse_obj(obj)

__init__()

classmethod from_file(path: Union[str, Path]) → OpenAPISpec

从文件路径获取OpenAPI规范。

参数

path (Union[str, Path]) –

返回类型

OpenAPISpec

classmethod from_spec_dict(spec_dict: dict) → OpenAPISpec

从字典获取OpenAPI规范。

参数

spec_dict (dict) –

返回类型

OpenAPISpec

classmethod from_text(text: str) → OpenAPISpec

从文本获取OpenAPI规范。

参数

text (str) –

返回类型

OpenAPISpec

classmethod from_url(url: str) → OpenAPISpec

从URL获取OpenAPI规范。

参数

url (str) –

返回类型

OpenAPISpec

static get_cleaned_operation_id(operation: Operation, path: str, method: str) → str

从操作ID获取一个清洗后的操作ID。

参数

• operation (Operation) –

• path (str) –

• 方法 (str) –

返回类型

str

get_methods_for_path(path: str) → List[str]

返回指定路径的有效方法列表。

参数

path (str) –

返回类型

List[str]

get_operation(path: str, method: str) → Operation

获取给定路径和HTTP方法的操作对象。

参数

• path (str) –

• 方法 (str) –

返回类型

Operation

get_parameters_for_operation(operation: Operation) → List[Parameter]

获取给定操作的结构。

参数

operation (Operation) –

返回类型

List[Parameter]

get_parameters_for_path(path: str) → List[Parameter]

参数

path (str) –

返回类型

List[Parameter]

get_referenced_schema(ref: Reference) → Schema

获取模式（或嵌套引用）或错误。

参数

ref (Reference) –

返回类型

Schema

get_request_body_for_operation(operation: Operation) → Optional[RequestBody]

获取给定操作的请求体。

参数

operation (Operation) –

返回类型

Optional[RequestBody]

get_schema(schema: Union[Reference, Schema]) → Schema

参数

schema (Union[Reference, Schema]) –

返回类型

Schema

classmethod parse_obj(obj: dict) → OpenAPISpec

参数

obj (dict) –

返回类型

OpenAPISpec