Nesse caso, você poderia querer documentar como essa API externa *deveria* ser. Que *operação de rota* ela deveria ter, que corpo ela deveria esperar, que resposta ela deveria retornar, etc.

 * to perform its tasks.
 * </p>
 *
 * <p>
 * The crawling process involves the following steps:
 * </p>
 * <ol>
 *   <li>Fetching a URL from the queue using {@link UrlQueueService#poll(String)}.</li>
 *   <li>Checking if the URL is valid using {@link #isValid(UrlQueue)}.</li>
 *   <li>Accessing the content using a {@link CrawlerClient} obtained from {@link CrawlerClientFactory}.</li>

---
- job:
    name: "elastic+elasticsearch+pull-request+packaging-tests-unix-sample"
    display-name: "elastic / elasticsearch - pull request packaging-tests-unix-sample"
    description: "Testing of Elasticsearch pull requests - packaging-tests-unix-sample"
    project-type: matrix
    node: master
    scm:
      - git:
          refspec: "+refs/pull/${ghprbPullId}/*:refs/remotes/origin/pr/${ghprbPullId}/*"
          branches:

---
- job:
    name: "elastic+elasticsearch+pull-request+packaging-tests-windows-nojdk"
    display-name: "elastic / elasticsearch - pull request packaging-tests-windows-nojdk"
    description: "Testing of Elasticsearch pull requests - packaging-tests-windows-nojdk"
    # We use a hard-coded workspace directory here to avoid hitting windows path length limits
    child-workspace: "C:\\Users\\jenkins\\workspace\\pr-packaging-windows\\${BUILD_NUMBER}"

O OpenAPI 3.1.0 (usado desde o FastAPI 0.99.0) adicionou suporte a `examples`, que faz parte do padrão **JSON Schema**.

Antes disso, ele suportava apenas a palavra‑chave `example` com um único exemplo. Isso ainda é suportado pelo OpenAPI 3.1.0, mas é descontinuado e não faz parte do padrão JSON Schema. Portanto, você é incentivado a migrar de `example` para `examples`. 🤓

Você pode ler mais no final desta página.

///

Da mesma forma, existem muitas ferramentas compatíveis. Incluindo ferramentas de geração de código para muitas linguagens.

## Pydantic { #pydantic }

Toda a validação de dados é realizada nos bastidores pelo [Pydantic](https://docs.pydantic.dev/), então você recebe todos os benefícios disso. E você sabe que está em boas mãos.

Você pode usar as mesmas declarações de tipo com `str`, `float`, `bool` e muitos outros tipos de dados complexos.

* **operação**: é `get`.
* **função**: é a função abaixo do "decorador" (abaixo do `@app.get("/")`).

{* ../../docs_src/first_steps/tutorial001_py310.py hl[7] *}

Esta é uma função Python.

Ela será chamada pelo **FastAPI** sempre que receber uma requisição para a URL "`/`" usando uma operação `GET`.

Neste caso, é uma função `async`.

---

Você também pode defini-la como uma função normal em vez de `async def`:

---
- job:
    name: "elastic+elasticsearch+pull-request+packaging-tests-windows-sample"
    display-name: "elastic / elasticsearch - pull request packaging-tests-windows-sample"
    description: "Testing of Elasticsearch pull requests - packaging-tests-windows-sample"
    # We use a hard-coded workspace directory here to avoid hitting windows path length limits
    child-workspace: "C:\\Users\\jenkins\\workspace\\pr-packaging-windows\\${BUILD_NUMBER}"

      encodings[0x3] = encoding // End of Text
      encodings[0x4] = encoding // End of Transmission
      encodings[0x5] = encoding // Enquiry
      encodings[0x6] = encoding // Acknowledgment
      encodings[0x7] = encoding // Bell
      encodings['\b'.code] = encoding // Backspace
      encodings[0xb] = encoding // Vertical Tab
      encodings[0xe] = encoding // Shift Out
      encodings[0xf] = encoding // Shift In

Como o FastAPI não tentará converter os dados para JSON com Pydantic nem serializá-los de nenhuma forma, neste caso a anotação de tipo serve apenas para seu editor e ferramentas; ela não será usada pelo FastAPI.

{* ../../docs_src/stream_data/tutorial001_py310.py ln[32:35] hl[33] *}