mirror of
https://github.com/fastapi/fastapi.git
synced 2026-11-01 22:02:42 -05:00
Rafael de Oliveira MarquesandMotov Yurii
540a83da65
* validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * validated llm translation * fix non-Annotated in llm-prompt * rerun after a few changes in llm-prompt * fix non-Annotated * validated llm translation * fix llm translation * update outdated translations * fix translation for operation IDs * add header link * add missing link * fix line break * fix diff * fix llm translation * fix 'Atualize' to 'Atualizar' * update alternatives.md * update async.md * update fastapi-cli.md * update features.md * update help-fastapi.md * update history-design-future.md * update index.md * update advanced/events.md * update advanced/middleware.md * update advanced/response-cookies.md * update advanced/response-headers.md * update advanced/templates.md * update advanced/testing-websockets.md * update advanced/using-request-directly.md * update advanced/websockets.md * update advanced/security/oauth2-scopes.md * update deployment/cloud.md * update deployment/manually.md * update how-to/custom-request-and-route.md * update how-to/migrate-from-pydantic-v1-to-pydantic-v2.md * update tutorial/background-tasks.md * update tutorial/first-steps.md * update tutorial/handling-errors.md * update tutorial/middleware.md * update tutorial/request-files.md * update tutorial/sql-databases.md * update tutorial/static-files.md * update tutorial/testing.md * update tutorial/dependencies/dependencies-with-yield.md * update advanced/advanced-dependencies.md --------- Co-authored-by: Motov Yurii <109919500+YuriiMotov@users.noreply.github.com>
73 lines
2.9 KiB
Markdown
73 lines
2.9 KiB
Markdown
# Modelos de Parâmetros do Cabeçalho { #header-parameter-models }
|
|
|
|
Se você possui um grupo de **parâmetros de cabeçalho** relacionados, você pode criar um **modelo do Pydantic** para declará-los.
|
|
|
|
Isso vai lhe permitir **reusar o modelo** em **múltiplos lugares** e também declarar validações e metadados para todos os parâmetros de uma vez. 😎
|
|
|
|
/// note | Nota
|
|
|
|
Isso é possível desde a versão `0.115.0` do FastAPI. 🤓
|
|
|
|
///
|
|
|
|
## Parâmetros do Cabeçalho com um Modelo Pydantic { #header-parameters-with-a-pydantic-model }
|
|
|
|
Declare os **parâmetros de cabeçalho** que você precisa em um **modelo do Pydantic**, e então declare o parâmetro como `Header`:
|
|
|
|
{* ../../docs_src/header_param_models/tutorial001_an_py310.py hl[9:14,18] *}
|
|
|
|
O **FastAPI** irá **extrair** os dados de **cada campo** a partir dos **cabeçalhos** da requisição e te retornará o modelo do Pydantic que você definiu.
|
|
|
|
## Checando a documentação { #check-the-docs }
|
|
|
|
Você pode ver os headers necessários na interface gráfica da documentação em `/docs`:
|
|
|
|
<div class="screenshot">
|
|
<img src="/img/tutorial/header-param-models/image01.png">
|
|
</div>
|
|
|
|
## Proibindo Cabeçalhos adicionais { #forbid-extra-headers }
|
|
|
|
Em alguns casos de uso especiais (provavelmente não muito comuns), você pode querer **restringir** os cabeçalhos que você quer receber.
|
|
|
|
Você pode usar a configuração dos modelos do Pydantic para proibir (`forbid`) quaisquer campos `extra`:
|
|
|
|
{* ../../docs_src/header_param_models/tutorial002_an_py310.py hl[10] *}
|
|
|
|
Se um cliente tentar enviar alguns **cabeçalhos extra**, eles irão receber uma resposta de **erro**.
|
|
|
|
Por exemplo, se o cliente tentar enviar um cabeçalho `tool` com o valor `plumbus`, ele irá receber uma resposta de **erro** informando que o parâmetro do cabeçalho `tool` não é permitido:
|
|
|
|
```json
|
|
{
|
|
"detail": [
|
|
{
|
|
"type": "extra_forbidden",
|
|
"loc": ["header", "tool"],
|
|
"msg": "Extra inputs are not permitted",
|
|
"input": "plumbus",
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Desativar conversão de underscores { #disable-convert-underscores }
|
|
|
|
Da mesma forma que com parâmetros de cabeçalho normais, quando você tem caracteres de sublinhado nos nomes dos parâmetros, eles são **automaticamente convertidos em hifens**.
|
|
|
|
Por exemplo, se você tem um parâmetro de cabeçalho `save_data` no código, o cabeçalho HTTP esperado será `save-data`, e ele aparecerá assim na documentação.
|
|
|
|
Se por algum motivo você precisar desativar essa conversão automática, também poderá fazê-lo para modelos do Pydantic para parâmetros de cabeçalho.
|
|
|
|
{* ../../docs_src/header_param_models/tutorial003_an_py310.py hl[19] *}
|
|
|
|
/// warning | Atenção
|
|
|
|
Antes de definir `convert_underscores` como `False`, tenha em mente que alguns proxies e servidores HTTP não permitem o uso de cabeçalhos com sublinhados.
|
|
|
|
///
|
|
|
|
## Resumo { #summary }
|
|
|
|
Você pode utilizar **modelos do Pydantic** para declarar **cabeçalhos** no **FastAPI**. 😎
|