# Extendendo o OpenAPI { #extending-openapi }

Existem alguns casos em que pode ser necessário modificar o esquema OpenAPI gerado.

Nesta seção, você verá como fazer isso.

## O processo normal { #the-normal-process }

O processo normal (padrão) é o seguinte:

Uma aplicação (instância) do `FastAPI` possui um método `.openapi()` que deve retornar o esquema OpenAPI.

//// tab | Informação

A única regra rígida para títulos é que o LLM deixe a parte do hash dentro de chaves inalterada, o que garante que os links não quebrem.

Veja a seção `### Headings` no prompt geral em `scripts/translate.py`.

Para algumas instruções específicas do idioma, veja, por exemplo, a seção `### Headings` em `docs/de/llm-prompt.md`.

////

## Termos usados na documentação { #terms-used-in-the-docs }

//// tab | Teste

E o resto será manipulado pelo **FastAPI**.

Se você rodar a aplicação e ir até [http://localhost:8000/v1/](http://localhost:8000/v1/), você verá o retorno do Flask:

```txt
Hello, World from Flask!
```

E se você for até [http://localhost:8000/v2](http://localhost:8000/v2), você verá o retorno do FastAPI:

```JSON
{
    "message": "Hello World"
}

## Recursos Adicionais { #additional-features }

O [Tutorial - Guia de Usuário](../tutorial/index.md) principal deve ser o suficiente para dar a você um tour por todos os principais recursos do **FastAPI**.

Nas próximas seções você verá outras opções, configurações, e recursos adicionais.

/// tip | Dica

As próximas seções **não são necessariamente "avançadas"**.

E é possível que para seu caso de uso, a solução esteja em uma delas.

///

Você verá a documentação automática da API para a aplicação principal, incluindo apenas suas próprias _operações de rota_:

<img src="/img/tutorial/sub-applications/image01.png">

E então, abra a documentação para a sub-aplicação, em [http://127.0.0.1:8000/subapi/docs](http://127.0.0.1:8000/subapi/docs).

O valor do parâmetro de path `item_id` será passado para a sua função como o argumento `item_id`.

Então, se você executar este exemplo e acessar [http://127.0.0.1:8000/items/foo](http://127.0.0.1:8000/items/foo), você verá uma resposta:

```JSON
{"item_id":"foo"}
```

## Parâmetros de path com tipos { #path-parameters-with-types }

* Selecionar "Python"
* Executar o depurador com a opção "`Python: Current File (Integrated Terminal)`".

Em seguida, ele iniciará o servidor com seu código **FastAPI**, parará em seus pontos de interrupção, etc.

Veja como pode parecer:

<img src="/img/tutorial/debugging/image01.png">

---

Se você usar o Pycharm, você pode:

* Abrir o menu "Executar".
* Selecionar a opção "Depurar...".

/// info | Informação

O FastAPI adicionou suporte a `Annotated` (e passou a recomendá-lo) na versão 0.95.0.

Se você tiver uma versão mais antiga, verá erros ao tentar usar `Annotated`.

Certifique-se de [Atualizar a versão do FastAPI](../deployment/versions.md#upgrading-the-fastapi-versions) para pelo menos 0.95.1 antes de usar `Annotated`.

///

### Verifique o código { #check-the-code }

* Verifique e leia o código, veja se faz sentido, **execute localmente** e veja se realmente resolve o problema.

* Depois **comente** dizendo que você fez isso, é assim que saberei que você realmente verificou.

/// info | Informação

*[Fess Site Search](https://github.com/codelibs/fess-site-search)* é uma alternativa gratuita ao [Google Site Search](https://enterprise.google.com/search/products/gss.html). Para mais detalhes, veja a [documentação do FSS JS Generator](https://fss-generator.codelibs.org/docs/manual).

## Site

[fess.codelibs.org](https://fess.codelibs.org/)

## Problemas/Perguntas