---

## API Reference

### Search APIs

#### JSON Search API

**Endpoints**:
- `GET /api/v1/documents?q={query}` (recommended)
- `GET /json/?q={query}` (legacy, for backward compatibility)

**Parameters**:
- `q` - Query string
- `num` - Results per page (default: 20)
- `start` - Starting offset (default: 0)
- `fields.label` - Label filter
- `lang` - Language preference

                    while (timeout > 0) {
                        response.wait(timeout);

                        /*
                         * JetDirect printer can respond to regular broadcast query
                         * with node status so we need to check to make sure that
                         * the record type matches the question type and if not,
                         * loop around and try again.

     *
     * @param plugin The plugin for which to resolve a version, must not be {@code null}.
     * @param session The repository session to use, must not be {@code null}.
     * @param repositories The plugin repositories to query, may be {@code null}.
     */
    public DefaultPluginVersionRequest(
            Plugin plugin, RepositorySystemSession session, List<RemoteRepository> repositories) {
        setGroupId(plugin.getGroupId());

import org.codelibs.fess.opensearch.config.exentity.CrawlingInfo;
import org.codelibs.fess.opensearch.config.exentity.CrawlingInfoParam;
import org.codelibs.fess.util.ComponentUtil;
import org.opensearch.index.query.QueryBuilders;
import org.opensearch.search.aggregations.AggregationBuilders;
import org.opensearch.search.aggregations.BucketOrder;
import org.opensearch.search.aggregations.bucket.terms.Terms;

然后，依赖项函数返回包含这些值的 `dict`。

### 导入 `Depends`

{* ../../docs_src/dependencies/tutorial001.py hl[3] *}

### 声明依赖项

与在*路径操作函数*参数中使用 `Body`、`Query` 的方式相同，声明依赖项需要使用 `Depends` 和一个新的参数：

{* ../../docs_src/dependencies/tutorial001.py hl[15,20] *}

虽然，在路径操作函数的参数中使用 `Depends` 的方式与 `Body`、`Query` 相同，但 `Depends` 的工作方式略有不同。

这里只能传给 Depends 一个参数。

且该参数必须是可调用对象，比如函数。

该函数接收的参数和*路径操作函数*的参数一样。

/// tip | 提示

    /**
     * Retrieves and displays cached content for a specific document.
     *
     * @param form the cache form containing document ID and highlight query
     * @return ActionResponse containing the cached document content or error redirect
     */
    @Execute
    public ActionResponse index(final CacheForm form) {

						</button>
					</div>
				</la:form>
			</div>
		</div>
	</div>
	<input type="hidden" id="contextPath" value="${contextPath}" />
	<script type="text/javascript" src="${fe:url('/js/admin/jquery-3.7.1.min.js')}"></script>
	<script type="text/javascript" src="${fe:url('/js/admin/popper.min.js')}"></script>
	<script type="text/javascript" src="${fe:url('/js/admin/bootstrap.min.js')}"></script>

    public abstract RegularFileProperty getHtmlFile();

    /**
     * The decorated HTML file
     */
    @OutputFile
    public abstract RegularFileProperty getDestinationFile();

    /**
     * JQuery used by the added decoration
     */
    @InputFiles
    @PathSensitive(PathSensitivity.NONE)
    public abstract ConfigurableFileCollection getJquery();

    /**

/// note | Hinweis

Dies wird seit FastAPI Version `0.115.0` unterstützt. 🤓

///

/// tip | Tipp

Diese gleiche Technik gilt für `Query`, `Cookie` und `Header`. 😎

///

## Cookies mit einem Pydantic-Modell { #cookies-with-a-pydantic-model }

* «path operations» (plural): «opérations de chemin»
* «path operation function»: «fonction de chemin»
* «path operation decorator»: «décorateur d'opération de chemin»

* «path parameter»: «paramètre de chemin»
* «query parameter»: «paramètre de requête»

* «the `Request`»: «`Request`» (keep as code identifier)
* «the `Response`»: «`Response`» (keep as code identifier)

* «deployment»: «déploiement»
* «to upgrade»: «mettre à niveau»