*/
    SuggestWriterResult write(Client client, SuggestSettings settings, String index, SuggestItem[] items, boolean update);

    /**
     * Deletes a suggestion from the specified index.
     *
     * @param client   the client to use for the operation
     * @param settings the settings to use for the operation

## Краткое описание и описание в документации — OpenAPI { #documentation-summary-and-description-openapi }

Чтобы добавить краткое описание и описание к вашим *операциям пути* и отобразить их в интерфейсе документации, прочитайте документацию: [Руководство — Конфигурации операций пути — Краткое описание и описание](../tutorial/path-operation-configuration.md#summary-and-description).

{* ../../docs_src/bigger_applications/app_an_py310/routers/users.py hl[1,3] title["app/routers/users.py"] *}

### *Pfadoperationen* mit `APIRouter` { #path-operations-with-apirouter }

Und dann verwenden Sie ihn, um Ihre *Pfadoperationen* zu deklarieren.

Verwenden Sie ihn auf die gleiche Weise wie die Klasse `FastAPI`:

Swagger UI bunu arka planda sizin için yönetir, ancak bu "redirect" yardımcısına ihtiyaç duyar.

///

### Test etmek için bir *path operation* oluşturun { #create-a-path-operation-to-test-it }

Şimdi her şeyin çalıştığını test edebilmek için bir *path operation* oluşturun:

{* ../../docs_src/custom_docs_ui/tutorial001_py310.py hl[36:38] *}

### Test edin { #test-it }

문서 UI에 표시되는 응답의 설명을 정의하려면 [튜토리얼 - 경로 처리 구성 - 응답 설명](../tutorial/path-operation-configuration.md#response-description) 문서를 읽어보세요.

## 문서화 *경로 처리* 지원 중단하기 - OpenAPI { #documentation-deprecate-a-path-operation-openapi }

*경로 처리*를 지원 중단(deprecate)으로 표시하고, 문서 UI에 보여주려면 [튜토리얼 - 경로 처리 구성 - 지원 중단](../tutorial/path-operation-configuration.md#deprecate-a-path-operation) 문서를 읽어보세요.

## 어떤 데이터든 JSON 호환으로 변환하기 { #convert-any-data-to-json-compatible }

- **Collections** (`org.codelibs.core.collection`) - Enhanced collection utilities, array operations, and specialized map/set implementations including LRU caches and case-insensitive collections

participant dep_func as Dep scope="function"
participant operation as Path Operation

    client ->> dep_req: Start request
    Note over dep_req: Run code up to yield
    dep_req ->> dep_func: Pass dependency
    Note over dep_func: Run code up to yield
    dep_func ->> operation: Run path operation with dependency
    operation ->> dep_func: Return from path operation
    Note over dep_func: Run code after yield

要定義在文件 UI 中顯示的回應描述，請參閱[教學 - 路徑操作設定 - 回應描述](../tutorial/path-operation-configuration.md#response-description)。

## 文件將*路徑操作*標記為已棄用 - OpenAPI { #documentation-deprecate-a-path-operation-openapi }

要將*路徑操作*標記為已棄用，並在文件 UI 中顯示，請參閱[教學 - 路徑操作設定 - 棄用](../tutorial/path-operation-configuration.md#deprecate-a-path-operation)。

## 將任意資料轉換為 JSON 相容格式 { #convert-any-data-to-json-compatible }

要將任意資料轉換為 JSON 相容格式，請參閱[教學 - JSON 相容編碼器](../tutorial/encoder.md)。

import org.codelibs.fess.suggest.request.Response;

/**
 * Represents the response of a suggest index operation.
 * This class contains information about the number of suggest documents,
 * the number of input documents, any errors that occurred during the operation,
 * and the time taken to complete the operation.
 */
public class SuggestIndexResponse implements Response {
    /** The number of suggest documents. */

在文档界面中定义并显示响应描述，请阅读 [教程 - 路径操作配置 - 响应描述](../tutorial/path-operation-configuration.md#response-description) 文档。

## 文档弃用**路径操作** - OpenAPI { #documentation-deprecate-a-path-operation-openapi }

在文档界面中显示弃用的**路径操作**，请阅读 [教程 - 路径操作配置 - 弃用](../tutorial/path-operation-configuration.md#deprecate-a-path-operation) 文档。

## 将任何数据转换为 JSON 兼容格式 { #convert-any-data-to-json-compatible }

要将任何数据转换为 JSON 兼容格式，请阅读 [教程 - JSON 兼容编码器](../tutorial/encoder.md) 文档。