/// tip | Dica

Se você chamar `app.openapi()` manualmente, você deveria atualizar os `operationId`s antes dessa chamada.

///

/// warning | Atenção

Se você fizer isso, você tem que ter certeza de que cada uma das suas *funções de operação de rota* tem um nome único.

Mesmo que elas estejam em módulos (arquivos Python) diferentes.

///

## Excluir do OpenAPI { #exclude-from-openapi }

///

## OpenAPI e documentação da API { #openapi-and-api-docs }

Se você retorna códigos de status adicionais e retornos diretamente, eles não serão incluídos no esquema do OpenAPI (a documentação da API), porque o FastAPI não tem como saber de antemão o que será retornado.

Esse `examples` **específico do OpenAPI** vai em outra seção da especificação OpenAPI. Ele fica nos **detalhes de cada *operação de rota***, não dentro de cada JSON Schema.

E o Swagger UI tem suportado esse campo `examples` particular há algum tempo. Então, você pode usá-lo para **mostrar** diferentes **exemplos na UI da documentação**.

Ela apenas retorna uma resposta JSON com o resultado do método `.openapi()` da aplicação.

Por padrão, o que o método `.openapi()` faz é verificar se a propriedade `.openapi_schema` tem conteúdo e retorná-lo.

Se não tiver, ele gera o conteúdo usando a função utilitária em `fastapi.openapi.utils.get_openapi`.

E essa função `get_openapi()` recebe como parâmetros:

labels.wizard_button_finish=Pular
labels.search_list_configuration=Pesquisa
labels.search_list_button_delete=Excluir
labels.search_list_delete_confirmation=Tem certeza de que deseja excluí-lo?
labels.search_list_button_delete_all=Excluir tudo com esta consulta
labels.search_list_delete_all_confirmation=Tem certeza de que deseja excluir tudo com esta consulta?
labels.search_list_button_cancel=Cancelar
labels.failure_url_configuration=URL de falha

Agora a sua API possui o poder de controlar o seu próprio <dfn title="Isso é uma brincadeira, só por precaução. Isso não tem nada a ver com consentimentos de cookies, mas é engraçado que até a API consegue rejeitar os coitados dos cookies. Coma um biscoito. 🍪">consentimento de cookie</dfn>. 🤪🍪

constraints.TypeFloat.message = {item} deve ser um número.
constraints.TypeDouble.message = {item} deve ser um número.
constraints.TypeAny.message = {item} não pode ser convertido para {propertyType}.
constraints.UriType.message = {item} tem uma URI não reconhecida.
constraints.CronExpression.message = {item} não é uma expressão CRON válida.

# ----------------------------------------------------------
# Application Exception
# ---------------------

Se você usa qualquer outra ferramenta para gerenciar suas instalações, como `uv`, Poetry, Pipenv ou outras, todas elas têm uma forma de definir versões específicas para seus pacotes.

## Versões disponíveis { #available-versions }

* `https://www.googleapis.com/auth/drive` é usado pelo Google.

/// info | Informação

No OAuth2, um "scope" é apenas uma string que declara uma permissão específica necessária.

Não importa se tem outros caracteres como `:` ou se é uma URL.

Esses detalhes são específicos da implementação.

Para OAuth2 são apenas strings.

///

Muitos desenvolvedores e times já dependem do **FastAPI** para seus projetos (incluindo eu e meu time).

Mas ainda há muitas melhorias e funcionalidades a vir.

**FastAPI** tem um grande futuro à frente.