package org.codelibs.fess.suggest.request;

/**
 * The Response interface serves as a marker interface for all response types
 * in the suggestion system. Implementations of this interface are used to
 * encapsulate the results of various operations and queries within the system.
 *
 * <p>Classes implementing this interface should provide specific details and
 * data relevant to the type of response they represent.</p>
 */
public interface Response {

/// tip

You will normally have much better performance using a [Response Model](../tutorial/response-model.md) than returning a `JSONResponse` directly, as that way it serializes the data using Pydantic, in Rust.

///

## Return a `Response` { #return-a-response }

You can return a `Response` or any sub-class of it.

/// info

`JSONResponse` itself is a sub-class of `Response`.

///

# Headers de Response { #response-headers }

## Usa un parámetro `Response` { #use-a-response-parameter }

Puedes declarar un parámetro de tipo `Response` en tu *path operation function* (como puedes hacer para cookies).

Y luego puedes establecer headers en ese objeto de response *temporal*.

{* ../../docs_src/response_headers/tutorial002_py310.py hl[1, 7:8] *}

///

## Повернення `Response` { #return-a-response }

Ви можете повертати `Response` або будь-який його підклас.

/// info | Інформація

`JSONResponse` сам є підкласом `Response`.

///

І коли ви повертаєте `Response`, **FastAPI** передасть його безпосередньо.

Ви також можете оголосити параметр `Response` у залежностях і встановлювати в них кукі (і заголовки).

## Повертайте `Response` безпосередньо { #return-a-response-directly }

Ви також можете створювати кукі, повертаючи `Response` безпосередньо у вашому коді.

Для цього ви можете створити відповідь, як описано в [Повернути відповідь безпосередньо](response-directly.md).

Потім встановіть у ньому кукі і поверніть його:

Також ви можете оголосити параметр `Response` у залежностях і встановлювати в них заголовки (та кукі).

## Поверніть `Response` безпосередньо { #return-a-response-directly }

Ви також можете додавати заголовки, коли повертаєте `Response` безпосередньо.

Створіть відповідь, як описано в [Повернення Response безпосередньо](response-directly.md), і передайте заголовки як додатковий параметр:

# Réponse personnalisée - HTML, flux, fichier, autres { #custom-response-html-stream-file-others }

Par défaut, **FastAPI** renvoie des réponses JSON.

Vous pouvez le remplacer en renvoyant une `Response` directement comme vu dans [Renvoyer une Response directement](response-directly.md).

///

## 返回 `Response` { #return-a-response }

事实上，你可以返回任意 `Response` 或者任意 `Response` 的子类。

/// info | 信息

`JSONResponse` 本身是一个 `Response` 的子类。

///

当你返回一个 `Response` 时，**FastAPI** 会直接传递它。

**FastAPI** 不会用 Pydantic 模型做任何数据转换，不会将响应内容转换成任何类型，等等。

这种特性给你极大的可扩展性。你可以返回任何数据类型，重写任何数据声明或者校验，等等。

///

## `Response` 반환하기 { #return-a-response }

`Response` 또는 그 하위 클래스를 반환할 수 있습니다.

/// info | 정보

`JSONResponse` 자체도 `Response`의 하위 클래스입니다.

///

그리고 `Response`를 반환하면 **FastAPI**가 이를 그대로 전달합니다.

Pydantic 모델로 데이터 변환을 수행하지 않으며, 내용을 다른 형식으로 변환하지 않습니다.

`Response` パラメータは依存関係でも宣言でき、そこで Cookie（やヘッダー）を設定することも可能です。

## `Response` を直接返す { #return-a-response-directly }

コードで `Response` を直接返すときに、Cookie を作成することもできます。

そのためには、[Response を直接返す](response-directly.md) で説明されているとおりにレスポンスを作成します。

そのレスポンスに Cookie を設定してから返します:

{* ../../docs_src/response_cookies/tutorial001_py310.py hl[10:12] *}

/// tip | 豆知識

`Response` パラメータを使わずにレスポンスを直接返す場合、FastAPI はそのレスポンスをそのまま返します。