> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overleaf 匯入 API

> 讓其他網站在 Kubernetes 部署中開啟 LaTeX 程式碼片段與專案。

匯入 API（`/docs` 與「Open in Ayakaleaf」按鈕，即 `open-in-overleaf` 模組）在每個 Ayakaleaf Pro Pod 的 **web** 服務中執行，且預設為開啟。以 URL 提供的檔案會透過同一個 Pod 中的 linked-url-proxy 下載。呼叫方式請參閱 [Overleaf 匯入 API](https://ayakaleaf-pro.mintlify.site/zh-TW/on-premises/configuration/overleaf-toolkit/integrations/overleaf-import-api.md)。

| | |
| - | - |
| 服務 | web（`open-in-overleaf` 模組）；透過 linked-url-proxy 下載 |
| 外部 → Overleaf | 瀏覽器從任何網站 `GET` 或 `POST ${OVERLEAF_SITE_URL}/docs` |
| Pod → 外部 | `snip_uri` 與 `zip_uri` 下載，其限制請參閱[外部 URL](https://ayakaleaf-pro.mintlify.site/zh-TW/on-premises/configuration/kubernetes/external-url.md) |
| 狀態 | 未登入訪客的請求，會在 Redis 中保留 10 分鐘，直到其登入 |
| 定期工作 | 無 |

### 設定

不需要任何設定即可啟用。ConfigMap 中的相關設定：

| 設定 | |
| - | - |
| `OVERLEAF_ALLOW_PUBLIC_ACCESS: "true"` | 未登入的訪客可以開啟 `/devs`，其送出的請求會保留到登入為止，請參閱[公開存取](https://ayakaleaf-pro.mintlify.site/zh-TW/on-premises/configuration/kubernetes/authentication/public-access.md)。 |
| `MAX_UPLOAD_SIZE` | 單一請求可攜帶的 ZIP 最大大小，單位為 MB（預設為 `50`）。您的 Ingress 或負載平衡器也必須接受該大小的請求內容。 |
| `OVERLEAF_LINKED_URL_*` | `snip_uri` 與 `zip_uri` 可指向哪些位址，請參閱[外部 URL](https://ayakaleaf-pro.mintlify.site/zh-TW/on-premises/configuration/kubernetes/external-url.md)。 |

### 多個副本

不需要額外設定。未登入訪客的請求保存在 Redis 中，因此無論訪客登入後連到哪個副本，都能繼續處理。

### 在 Kubernetes 上的測試

在 Kubernetes 1.37 上以一個副本進行測試，匯入 API 的端對端測試全數通過（14 個案例）：`/devs` 頁面及其範例專案、將程式碼片段、完整文件、URL 編碼的連結以及來自 data URL 的檔案轉換為專案、拒絕無法成為專案的提交、拒絕從內部位址下載、未登入時的 POST 與連結在登入後保留，以及在啟用 `OVERLEAF_ALLOW_PUBLIC_ACCESS` 時，未登入訪客可存取 `/devs`，且送出的程式碼片段在登入後恢復一次；最後一個案例在三個副本置於 HAProxy 之後的情況下也能通過。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.