gen_schema
app.utils.gen_schema
Funciones de utilidad para convertir modelos de Pydantic a JSON Schema.
Para más información, te recomendamos leer la documentación del Proyecto.
- https://docs.pydantic.dev/2.8/concepts/models/#custom-root-types
- https://docs.pydantic.dev/2.8/concepts/models/#rootmodel-and-custom-root-types
- https://docs.pydantic.dev/2.8/api/json_schema/#pydantic.json_schema.GenerateJsonSchema.generate_definitions
- https://docs.pydantic.dev/2.8/concepts/json_schema/
generate_schema(title, list_dto_class=None, to_json=True)
Genera schemas compatibles con JSON Schema, a partir de modelos de Pydantic.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
title | str | el titulo para el esquema a generar | required |
list_dto_class | list[Any] | Una lista de modelos de Pydantic, por defecto | None |
to_json | bool | establece si se genera un esquema ó solo información básica de los modelos de Pydantic enviados, por defecto | True |
Returns:
| Type | Description |
|---|---|
Optional[dict[str, Any]] | un diccionario con la definición de los metadatos ó |