# The website is built using MkDocs with the Material theme.
# https://squidfunk.github.io/mkdocs-material/
# It requires Python to run.
# Install the packages with the following command:
# pip install mkdocs mkdocs-material mkdocs-redirects

set -ex

# Test generating the javadoc jars
./gradlew publishToMavenLocal -DRELEASE_SIGNING_ENABLED=false -PokhttpDokka=true

# Generate the API docs
./gradlew dokkaGeneratePublicationHtml -PokhttpDokka=true

### EventListener

Subclass [EventListener](https://square.github.io/okhttp/5.x/okhttp/okhttp3/-event-listener/) and override methods for the events you are interested in. In a successful HTTP call with no redirects or retries the sequence of events is described by this flow.

![Events Diagram](../assets/images/******@****.***)

## [Calls](https://square.github.io/okhttp/5.x/okhttp/okhttp3/-call/)

    /**
     * Handles the prologue phase of action execution.
     * <p>
     * This method catches UserRoleLoginException and redirects to the
     * appropriate action class.
     * </p>
     *
     * @param runtime the action runtime context
     * @return the action response, or redirect response if login exception occurs
     */
    @Override
    public ActionResponse godHandPrologue(final ActionRuntime runtime) {

    - skip_users: ../en/data/skip_users.yml
    - members: ../en/data/members.yml
    - sponsors_badge: ../en/data/sponsors_badge.yml
    - sponsors: ../en/data/sponsors.yml
    - topic_repos: ../en/data/topic_repos.yml
  redirects:
    redirect_maps:
      deployment/deta.md: deployment/cloud.md
      advanced/graphql.md: how-to/graphql.md
      advanced/custom-request-and-route.md: how-to/custom-request-and-route.md

    "jieba >=0.42.1",
    "markdown-include-variants >=0.0.8",
    "mdx-include >=1.4.1,<2.0.0",
    "mkdocs-macros-plugin >=1.5.0",
    "mkdocs-material >=9.7.0",
    "mkdocs-redirects >=1.2.1,<1.3.0",
    "mkdocstrings[python] >=0.30.1",
    "pillow >=11.3.0",
    "python-slugify >=8.0.4",
    "pyyaml >=5.3.1,<7.0.0",
    "typer >=0.21.1",
]
docs-tests = [
    "httpx >=0.23.0,<1.0.0",

     * @param url the URL to process
     * @return a map containing the processed document data
     * @throws CrawlingAccessException if crawling fails or configuration is invalid
     * @throws ChildUrlsException if the URL redirects to another location
     * @throws CrawlerSystemException if data deserialization fails
     */
    public Map<String, Object> processRequest(final CrawlingConfig crawlingConfig, final String crawlingInfoId, final String url) {

```console
$ fastapi run --forwarded-allow-ips="*"

<span style="color: green;">INFO</span>:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```

</div>

### HTTPS에서 리디렉션 { #redirects-with-https }

예를 들어, *경로 처리* `/items/`를 정의했다고 해봅시다:

{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *}

클라이언트가 `/items`로 접근하면, 기본적으로 `/items/`로 리디렉션됩니다.

```console
$ fastapi run --forwarded-allow-ips="*"

<span style="color: green;">INFO</span>:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```

</div>

### 使用 HTTPS 的重新導向 { #redirects-with-https }

例如，假設你定義了一個「路徑操作（path operation）」`/items/`：

{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *}

如果用戶端嘗試前往 `/items`，預設會被重新導向到 `/items/`。

```console
$ fastapi run --forwarded-allow-ips="*"

<span style="color: green;">INFO</span>:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```

</div>

### 使用 HTTPS 的重定向 { #redirects-with-https }

例如，假设你定义了一个*路径操作* `/items/`：

{* ../../docs_src/behind_a_proxy/tutorial001_01_py310.py hl[6] *}

如果客户端尝试访问 `/items`，默认会被重定向到 `/items/`。