-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
🌐 Add Portuguese translation for docs/pt/docs/advanced/response-directly.md
#12266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
alejsdev
merged 2 commits into
fastapi:master
from
Joao-Pedro-P-Holanda:docs/response-directly
Oct 4, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Retornando uma Resposta Diretamente | ||
|
|
||
| Quando você cria uma *operação de rota* no **FastAPI** você pode retornar qualquer dado nela: um dicionário (`dict`), uma lista (`list`), um modelo do Pydantic ou do seu banco de dados, etc. | ||
|
|
||
| Por padrão, o **FastAPI** irá converter automaticamente o valor do retorno para JSON utilizando o `jsonable_encoder` explicado em [JSON Compatible Encoder](../tutorial/encoder.md){.internal-link target=_blank}. | ||
|
|
||
| Então, por baixo dos panos, ele incluiria esses dados compatíveis com JSON (e.g. um `dict`) dentro de uma `JSONResponse` que é utilizada para enviar uma resposta para o cliente. | ||
|
|
||
| Mas você pode retornar a `JSONResponse` diretamente nas suas *operações de rota*. | ||
|
|
||
| Pode ser útil para retornar cabeçalhos e cookies personalizados, por exemplo. | ||
|
|
||
| ## Retornando uma `Response` | ||
|
|
||
| Na verdade, você pode retornar qualquer `Response` ou subclasse dela. | ||
|
|
||
| /// tip | Dica | ||
|
|
||
| A própria `JSONResponse` é uma subclasse de `Response`. | ||
|
|
||
| /// | ||
|
|
||
| E quando você retorna uma `Response`, o **FastAPI** vai repassá-la diretamente. | ||
|
|
||
| Ele não vai fazer conversões de dados com modelos do Pydantic, não irá converter a tipagem de nenhum conteúdo, etc. | ||
|
|
||
| Isso te dá bastante flexibilidade. Você pode retornar qualquer tipo de dado, sobrescrever qualquer declaração e validação nos dados, etc. | ||
|
|
||
| ## Utilizando o `jsonable_encoder` em uma `Response` | ||
|
|
||
| Como o **FastAPI** não realiza nenhuma mudança na `Response` que você retorna, você precisa garantir que o conteúdo dela está pronto para uso. | ||
|
|
||
| Por exemplo, você não pode colocar um modelo do Pydantic em uma `JSONResponse` sem antes convertê-lo em um `dict` com todos os tipos de dados (como `datetime`, `UUID`, etc) convertidos para tipos compatíveis com JSON. | ||
|
|
||
| Para esses casos, você pode usar o `jsonable_encoder` para converter seus dados antes de repassá-los para a resposta: | ||
|
|
||
| ```Python hl_lines="6-7 21-22" | ||
| {!../../../docs_src/response_directly/tutorial001.py!} | ||
| ``` | ||
|
|
||
| /// note | Detalhes Técnicos | ||
|
|
||
| Você também pode utilizar `from starlette.responses import JSONResponse`. | ||
|
|
||
| **FastAPI** utiliza a mesma `starlette.responses` como `fastapi.responses` apenas como uma conveniência para você, desenvolvedor. Mas maior parte das respostas disponíveis vem diretamente do Starlette. | ||
|
|
||
| /// | ||
|
|
||
| ## Retornando uma `Response` | ||
|
|
||
| O exemplo acima mostra todas as partes que você precisa, mas ainda não é muito útil, já que você poderia ter retornado o `item` diretamente, e o **FastAPI** colocaria em uma `JSONResponse` para você, convertendo em um `dict`, etc. Tudo isso por padrão. | ||
|
|
||
| Agora, vamos ver como você pode usar isso para retornar uma resposta personalizada. | ||
|
|
||
| Vamos dizer quer retornar uma resposta <a href="https://pt.wikipedia.org/wiki/XML" class="external-link" target="_blank">XML</a>. | ||
|
|
||
| Você pode colocar o seu conteúdo XML em uma string, colocar em uma `Response`, e retorná-lo: | ||
|
|
||
| ```Python hl_lines="1 18" | ||
| {!../../../docs_src/response_directly/tutorial002.py!} | ||
| ``` | ||
|
|
||
| ## Notas | ||
|
|
||
| Quando você retorna uma `Response` diretamente os dados não são validados, convertidos (serializados) ou documentados automaticamente. | ||
|
|
||
| Mas você ainda pode documentar como descrito em [Retornos Adicionais no OpenAPI | ||
| ](additional-responses.md){.internal-link target=_blank}. | ||
|
|
||
| Você pode ver nas próximas seções como usar/declarar essas `Responses` customizadas enquanto mantém a conversão e documentação automática dos dados. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.