* Gerando **erros automáticos** retornados ao cliente quando os dados são inválidos.
* **Documentar** a API usando OpenAPI:
    * que é usada pelas interfaces de usuário da documentação interativa automática.

Tudo isso pode parecer abstrato. Não se preocupe. Você verá tudo isso em ação no [Tutorial - Guia do usuário](tutorial/index.md).

<img src="/img/tutorial/response-model/image01.png">

E ambos os modelos serão usados ​​para a documentação interativa da API:

<img src="/img/tutorial/response-model/image02.png">

## Outras anotações de tipo de retorno { #other-return-type-annotations }

Esse é o benefício dos padrões...

///

## Veja em ação { #see-it-in-action }

Abra o docs interativo: [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs).

### Autentique-se { #authenticate }

Clique no botão "Authorize".

Use as credenciais:

User: `johndoe`

Password: `secret`

    // ===================================================================================
    // Attribute
    // =========

    /** Client for interacting with the search engine. */
    @Resource
    protected SearchEngineClient searchEngineClient;

    /** Helper for building and parsing search queries. */
    @Resource
    protected QueryHelper queryHelper;

HDFS atomic rename functionality to complete writing data to the datastore. Object storage operations are atomic by nature and they do not require/implement rename API. The default S3A committer emulates renames through copy and delete APIs. This interaction pattern causes significant loss of performance because of the write amplification. _Netflix_, for example, developed two new staging committers - the Directory staging committer and the Partitioned staging committer - to take full advantage of native...

<img src="/img/tutorial/response-model/image01.png">

Et les deux modèles seront utilisés pour la documentation API interactive :

<img src="/img/tutorial/response-model/image02.png">

## Autres annotations de type de retour { #other-return-type-annotations }

The first part of the communication is just to establish the connection between the client and the server and to decide the cryptographic keys they will use, etc.

<img src="/img/deployment/https/https02.drawio.svg">

This interaction between the client and the server to establish the TLS connection is called the **TLS handshake**.

### TLS with SNI Extension { #tls-with-sni-extension }

    @Resource
    protected LabelTypeBhv labelTypeBhv;

    /** Configuration settings for Fess application */
    @Resource
    protected FessConfig fessConfig;

    /** Client for interacting with the search engine */
    @Resource
    protected SearchEngineClient searchEngineClient;

    /**
     * Retrieves a paginated list of elevate words based on the provided pager criteria.
     *

### 自动生成文档 { #automatic-docs }

交互式 API 文档以及具探索性 web 界面。因为该框架是基于 OpenAPI，所以有很多可选项，FastAPI 默认自带两个交互式 API 文档。

* [**Swagger UI**](https://github.com/swagger-api/swagger-ui)，可交互式操作，能在浏览器中直接调用和测试你的 API。

![Swagger UI interaction](https://fastapi.tiangolo.com/img/index/index-03-swagger-02.png)

* 另外的 API 文档：[**ReDoc**](https://github.com/Rebilly/ReDoc)

![ReDoc](https://fastapi.tiangolo.com/img/index/index-06-redoc-02.png)

                        user = auth.getUserName();
                        password = new String(auth.getPassword());
                    } catch (final Exception ex) {
                        log.debug("Interactive authentication failed", ex);
                    }
                }
                final Type2Message type2 = (Type2Message) message;