## URLs der OpenAPI-Dokumentationen

<img src="/img/tutorial/generate-clients/image08.png">

## Vorteile

Wenn Sie die automatisch generierten Clients verwenden, erhalten Sie **automatische Codevervollständigung** für:

* Methoden.
* Request-Payloads im Body, Query-Parameter, usw.
* Response-Payloads.

import jakarta.annotation.Resource;

/**
 * API action for admin document management.
 * Provides RESTful API endpoints for bulk document operations in the Fess search engine.
 * Supports indexing multiple documents with automatic field validation and default value assignment.
 */
public class ApiAdminDocumentsAction extends FessApiAdminAction {

    // ===================================================================================
    // Constant

* Ótimo suporte do editor.
* Conversão de dados das requisições recebidas.
* Conversão de dados para os dados da resposta.
* Validação de dados.
* Anotação e documentação automáticas.

## Outros tipos de dados

Aqui estão alguns dos tipos de dados adicionais que você pode usar:

* `UUID`:

 * handling without tight coupling to specific parameter schemas.</p>
 */
public class DataStoreParams {

    /**
     * Internal map storing parameter key-value pairs.
     * Uses ParamMap for automatic case format conversion between camelCase and snake_case.
     */
    protected final Map<String, Object> params;

    /**
     * Creates a new empty DataStoreParams instance.

* Show a **clear error** for the client when the data is not valid
* **Document** the parameter in the OpenAPI schema *path operation* (so it will show up in the **automatic docs UI**)

## Alternative (old): `Query` as the default value { #alternative-old-query-as-the-default-value }

* Editor support (obviously)
* Data <abbr title="converting the string that comes from an HTTP request into Python data">"parsing"</abbr>
* Data validation
* Automatic documentation

## Defaults { #defaults }

As query parameters are not a fixed part of a path, they can be optional and can have default values.

In the example above they have default values of `skip=0` and `limit=10`.

     * The given dependency should be one of the paths returned by {@link #getDependencies()}.
     * The module name is extracted from the {@code module-info.class} file if present, otherwise from
     * the {@code "Automatic-Module-Name"} attribute of the {@code META-INF/MANIFEST.MF} file if present.
     *
     * <p>A typical usage is to invoke this method for all dependencies having a

///

/// check

OpenAPI verlangt, dass jede *Pfadoperation* über eine Beschreibung der Response verfügt.

Daher, wenn Sie keine vergeben, wird **FastAPI** automatisch eine für „Erfolgreiche Response“ erstellen.

///

<img src="/img/tutorial/path-operation-configuration/image03.png">

## Eine *Pfadoperation* deprecaten

Dies kann es Ihren Benutzern viel einfacher machen, **deren APIs zu implementieren**, um Ihre **Webhook**-Requests zu empfangen. Möglicherweise können diese sogar einen Teil des eigenem API-Codes automatisch generieren.

/// info

Webhooks sind in OpenAPI 3.1.0 und höher verfügbar und werden von FastAPI `0.99.0` und höher unterstützt.

///

## Eine Anwendung mit Webhooks