`Header` - это "родственный" класс `Path`, `Query` и `Cookie`. Он также наследуется от того же общего класса `Param`.

Но помните, что когда вы импортируете `Query`, `Path`, `Header` и другие из `fastapi`, на самом деле это функции, которые возвращают специальные классы.

///

/// info | Информация

Чтобы объявить заголовки, важно использовать `Header`, иначе параметры интерпретируются как query-параметры.

///

from typing import Optional

import pytest
from fastapi import FastAPI, Query
from pydantic import BaseModel


def test_invalid_sequence():
    with pytest.raises(AssertionError):
        app = FastAPI()

        class Item(BaseModel):
            title: str

        @app.get("/items/")
        def read_items(q: list[Item] = Query(default=None)):
            pass  # pragma: no cover


def test_invalid_tuple():

    }


def test_query_params_str_validations_q_query(client: TestClient):
    response = client.get("/items/", params={"q": "query"})
    assert response.status_code == 200
    assert response.json() == {
        "items": [{"item_id": "Foo"}, {"item_id": "Bar"}],
        "q": "query",
    }


def test_query_params_str_validations_q_short(client: TestClient):
    response = client.get("/items/", params={"q": "fa"})

 * <li>{@link #deleteByQuery(String)} - Delete suggest items by query string.
 * <li>{@link #deleteByQuery(QueryBuilder)} - Delete suggest items by query builder.
 * <li>{@link #deleteAll()} - Delete all suggest items.
 * <li>{@link #deleteDocumentWords()} - Delete document words.
 * <li>{@link #deleteQueryWords()} - Delete query words.
 * <li>{@link #indexFromQueryLog(QueryLog)} - Index from a single query log.

import java.io.Closeable;

/**
 * The {@code QueryLogReader} interface provides methods to read query logs and close the reader.
 * It extends the {@code Closeable} interface, ensuring that resources can be released when no longer needed.
 */
public interface QueryLogReader extends Closeable {
    /**
     * Reads a query log.
     * @return The query log.
     */
    QueryLog read();

    @Override
    void close();

    }

    public void setQueryId_Terms(ConditionOptionCall<TermsAggregationBuilder> opLambda) {
        setQueryId_Terms("queryId", opLambda, null);
    }

    public void setQueryId_Terms(ConditionOptionCall<TermsAggregationBuilder> opLambda, OperatorCall<BsSearchLogCA> aggsLambda) {
        setQueryId_Terms("queryId", opLambda, aggsLambda);
    }

        // Default constructor
    }

    /**
     * Wraps a query string with wildcard characters to enable partial matching.
     * This method ensures that the query string is surrounded by asterisks (*)
     * to support prefix and suffix matching in search operations.
     *
     * @param query the query string to wrap with wildcards
     * @return the wrapped query string with leading and trailing asterisks
     */

Sie können Header-Parameter genauso definieren, wie Sie `Query`-, `Path`- und `Cookie`-Parameter definieren.

## `Header` importieren { #import-header }

Importieren Sie zuerst `Header`:

{* ../../docs_src/header_params/tutorial001_an_py310.py hl[3] *}

## `Header`-Parameter deklarieren { #declare-header-parameters }

Deklarieren Sie dann die Header-Parameter mit derselben Struktur wie bei `Path`, `Query` und `Cookie`.

            "type": "keyword"
          }
        }
      }
    ],
    "properties": {
      "user": {
        "type": "keyword"
      },
      "roles": {
        "type": "keyword"
      },
      "queryId": {
        "type": "keyword"
      },
      "searchWord": {
        "type": "keyword"
      },
      "requestedAt": {
        "type": "date",
        "format": "date_optional_time"
      },

import org.opensearch.index.query.RangeQueryBuilder;
import org.opensearch.index.query.RegexpQueryBuilder;
import org.opensearch.index.query.SpanTermQueryBuilder;
import org.opensearch.index.query.TermQueryBuilder;
import org.opensearch.index.query.TermsQueryBuilder;
import org.opensearch.index.query.WildcardQueryBuilder;
import org.opensearch.index.query.functionscore.FunctionScoreQueryBuilder;