keystone.api.validation package

子模块

Module contents

API request/response validating middleware.

keystone.api.validation.request_body_schema(schema: Dict[str, Any] | None = None)[source]

注册一个 schema 来验证请求体。

schema 将在 API 方法执行之前用于验证请求体。

参数：

  • schema – 用于验证目标的 JSON Schema。如果传入空值，则不执行验证。

  • min_version – 一个字符串，表示 schema 适用的最低 API 版本。

  • max_version – 一个字符串，表示 schema 适用的最高 API 版本。

keystone.api.validation.request_query_schema(schema: Dict[str, Any] | None = None)[source]

注册一个 schema 来验证请求查询字符串参数。

schema 将在 API 方法执行之前用于验证请求查询字符串。

参数：

schema – 用于验证目标的 JSON Schema。如果传入空值，则不执行验证。

keystone.api.validation.response_body_schema(schema: Dict[str, Any] | None = None)[source]

注册一个 schema 来验证响应体。

schema 将在 API 方法执行之后用于验证响应体。

参数：

  • schema – 用于验证目标的 JSON Schema。如果传入空值，则不执行验证。

  • min_version – 一个字符串，表示 schema 适用的最低 API 版本。

  • max_version – 一个字符串，表示 schema 适用的最高 API 版本。

keystone.api.validation.validated(cls)[source]