## Tags de Documentação - OpenAPI { #documentation-tags-openapi }

Se algo parecer interessante e útil para o seu projeto, vá em frente e dê uma olhada. Caso contrário, você pode simplesmente ignorá-las.

/// tip | Dica

Se você deseja **aprender FastAPI** de forma estruturada (recomendado), leia capítulo por capítulo [Tutorial - Guia de Usuário](../tutorial/index.md) em vez disso.

/// tip | Dica

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

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

///

## Leia o Tutorial primeiro { #read-the-tutorial-first }

As próximas seções pressupõem que você já leu o principal [Tutorial - Guia de Usuário: Segurança](../../tutorial/security/index.md).

/// 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.

///

## Leia o Tutorial primeiro { #read-the-tutorial-first }

Você ainda pode usar a maior parte dos recursos no **FastAPI** com o conhecimento do [Tutorial - Guia de Usuário](../tutorial/index.md) principal.

{* ../../docs_src/configure_swagger_ui/tutorial003_py310.py hl[3] *}

## Outros parâmetros da UI do Swagger { #other-swagger-ui-parameters }

Para ver todas as outras configurações possíveis que você pode usar, leia a [documentação oficial dos parâmetros da UI do Swagger](https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/).

## Configurações somente JavaScript { #javascript-only-settings }

E se houver qualquer outra necessidade de estilo ou consistência, vou pedir diretamente, ou vou adicionar commits por cima com as mudanças necessárias.

### 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

No entanto, <dfn title="2023-08-26">no momento em que isto foi escrito</dfn>, o Swagger UI, a ferramenta responsável por exibir a UI da documentação, não suporta mostrar vários exemplos para os dados no **JSON Schema**. Mas leia abaixo para uma solução alternativa.

### `examples` específicos do OpenAPI { #openapi-specific-examples }

Use o parâmetro `tags` com suas *operações de rota* (e `APIRouter`s) para atribuí-los a diferentes tags:

{* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *}

/// info | Informação

Leia mais sobre tags em [Configuração de operação de rota](path-operation-configuration.md#tags).

///

### Cheque os documentos { #check-the-docs }

```Python
from .routers import items, users
```

A segunda versão é uma "importação absoluta":

```Python
from app.routers import items, users
```

Para saber mais sobre pacotes e módulos Python, leia [a documentação oficial do Python sobre módulos](https://docs.python.org/3/tutorial/modules.html).

///

### Evite colisões de nomes { #avoid-name-collisions }

* Kubernetes com um controlador Ingress como o Nginx
    * Com um componente externo como cert-manager para renovações de certificados
* Gerenciado internamente por um provedor de nuvem como parte de seus serviços (leia abaixo 👇)