fastapi-todo

Como definir os modelos Pydantic para representar tarefas com atributos como título, descrição, prioridade e status?

Você pode definir os modelos Pydantic para representar uma tarefa com os atributos título, descrição, prioridade e status da seguinte forma:

from pydantic import BaseModel, Field
from typing import Optional, Literal

class Task(BaseModel):
    title: str = Field(..., description="Título da tarefa")
    description: Optional[str] = Field(None, description="Descrição detalhada da tarefa")
    priority: int = Field(..., ge=1, le=5, description="Prioridade da tarefa (1 a 5)")
    status: Literal["pendente", "em andamento", "concluída"] = Field(..., description="Status da tarefa")

• title: obrigatório, tipo str, representa o título da tarefa.
• description: opcional, tipo str, permite uma descrição detalhada.
• priority: obrigatório, tipo int, pode ser validado para aceitar apenas valores de 1 a 5 (por exemplo, usando o parâmetro ge e le do Field)¹²³.
• status: obrigatório, tipo Literal, restringe os valores permitidos para “pendente”, “em andamento” ou “concluída”, garantindo maior segurança e clareza na API³.

Você pode usar o recurso Field do Pydantic para adicionar validações, descrições e exemplos aos campos, o que melhora a documentação automática da API¹².

Esse modelo pode ser utilizado tanto para entrada (criação/atualização) quanto para resposta, conforme a necessidade dos endpoints⁴³.

⁂

1. https://pythonacademy.com.br/blog/pydantic-e-tipos-avancados ↩ ↩²

2. https://pythonacademy.com.br/blog/introducao-ao-pydantic-validacao-e-modelagem-de-dados-simplificada-com-python ↩ ↩²

3. https://fastapi.tiangolo.com/pt/python-types/ ↩ ↩² ↩³

4. https://fastapi.tiangolo.com/pt/tutorial/response-model/ ↩

This site is open source. Improve this page.