# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: Scalar API Reference spec: description: | Scalar is an open-source API platform that generates beautiful, interactive API documentation from OpenAPI/Swagger specifications. Mount your spec file or provide a URL, and get a modern API reference with a built-in API client for testing endpoints directly in the browser. coverImage: https://avatars.githubusercontent.com/u/301879 icon: https://avatars.githubusercontent.com/u/301879 variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access Scalar API Reference tags: - Tool - Developer readme: | # Scalar API Reference An open-source platform that turns OpenAPI/Swagger specifications into beautiful, interactive API documentation. Includes a built-in API client for testing endpoints directly in the browser. ## What You Can Do After Deployment 1. **Visit your domain** — see the default Galaxy API reference 2. **Configure your spec** — update the API_REFERENCE_CONFIG environment variable with your OpenAPI spec URL 3. **Test endpoints** — use the built-in API client to make requests directly from the documentation 4. **Customize the theme** — choose from multiple color themes (purple, blue, orange, etc.) 5. **Mount local specs** — mount OpenAPI documents to /docs inside the container ## Key Features - Beautiful, modern API documentation from OpenAPI 3.x and Swagger 2.0 specs - Built-in API client for testing endpoints in the browser - Multiple theme options with dark mode support - Support for mounting local spec files or referencing URLs - Health check endpoint at /health - Lightweight single container deployment - First-class OpenAPI and Swagger support ## License MIT — [GitHub](https://github.com/scalar/scalar) | [Website](https://scalar.com) services: - name: scalar-api-reference icon: https://avatars.githubusercontent.com/u/301879 template: PREBUILT_V2 spec: source: image: scalarapi/api-reference:0.5.17 ports: - id: web port: 8080 type: HTTP env: API_REFERENCE_CONFIG: default: '{"sources":[{"url":"https://registry.scalar.com/@scalar/apis/galaxy?format=json"}],"theme":"purple"}' expose: true healthCheck: type: HTTP port: web http: path: /health domainKey: PUBLIC_DOMAIN localization: es-ES: description: | Scalar es una plataforma API de código abierto que genera documentación API interactiva y atractiva a partir de especificaciones OpenAPI/Swagger. Monte su archivo de especificación o proporcione una URL para obtener una referencia API moderna con un cliente API integrado. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a Scalar API Reference readme: | # Scalar API Reference Plataforma de código abierto que convierte especificaciones OpenAPI/Swagger en documentación API interactiva y atractiva. Incluye un cliente API integrado para probar endpoints directamente en el navegador. ## Qué puedes hacer después del despliegue 1. **Visita tu dominio** — ver la referencia API Galaxy por defecto 2. **Configura tu especificación** — actualiza API_REFERENCE_CONFIG con la URL de tu especificación OpenAPI 3. **Prueba endpoints** — usa el cliente API integrado para hacer peticiones desde la documentación 4. **Personaliza el tema** — elige entre múltiples temas de colores 5. **Monta especificaciones locales** — monta documentos OpenAPI en /docs del contenedor ## Características - Documentación API atractiva desde OpenAPI 3.x y Swagger 2.0 - Cliente API integrado para probar endpoints en el navegador - Múltiples opciones de temas con modo oscuro - Soporte para montar archivos locales o referenciar URLs - Despliegue ligero en contenedor único ## Licencia MIT — [GitHub](https://github.com/scalar/scalar) id-ID: description: | Scalar adalah platform API open-source yang menghasilkan dokumentasi API interaktif dan menarik dari spesifikasi OpenAPI/Swagger. Mount file spesifikasi atau berikan URL untuk mendapatkan referensi API modern dengan klien API bawaan untuk menguji endpoint langsung di browser. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses Scalar API Reference readme: | # Scalar API Reference Platform open-source yang mengubah spesifikasi OpenAPI/Swagger menjadi dokumentasi API interaktif dan menarik. Dilengkapi klien API bawaan untuk menguji endpoint langsung di browser. ## Apa yang bisa dilakukan setelah deploy 1. **Buka domain** — lihat referensi API Galaxy default 2. **Konfigurasi spesifikasi** — perbarui API_REFERENCE_CONFIG dengan URL spesifikasi OpenAPI Anda 3. **Uji endpoint** — gunakan klien API bawaan untuk mengirim request dari dokumentasi 4. **Kustomisasi tema** — pilih dari berbagai tema warna 5. **Mount spesifikasi lokal** — mount dokumen OpenAPI ke /docs di kontainer ## Fitur - Dokumentasi API menarik dari OpenAPI 3.x dan Swagger 2.0 - Klien API bawaan untuk menguji endpoint di browser - Berbagai opsi tema dengan mode gelap - Dukungan mount file lokal atau referensi URL - Deploy ringan dalam satu kontainer ## Lisensi MIT — [GitHub](https://github.com/scalar/scalar) ja-JP: description: | ScalarはOpenAPI/Swagger仕様から美しいインタラクティブなAPIドキュメントを生成するオープンソースAPIプラットフォームです。仕様ファイルをマウントするかURLを指定するだけで、ブラウザ内蔵APIクライアント付きのモダンなAPIリファレンスが利用できます。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: Scalar API Referenceにアクセスするためのドメイン readme: | # Scalar API Reference OpenAPI/Swagger仕様を美しいインタラクティブなAPIドキュメントに変換するオープンソースプラットフォーム。ブラウザ内蔵APIクライアントでエンドポイントを直接テスト可能。 ## デプロイ後にできること 1. **ドメインにアクセス** — デフォルトのGalaxy APIリファレンスを表示 2. **仕様を設定** — API_REFERENCE_CONFIG環境変数にOpenAPI仕様URLを設定 3. **エンドポイントをテスト** — 内蔵APIクライアントでドキュメントから直接リクエスト 4. **テーマをカスタマイズ** — 複数のカラーテーマから選択 5. **ローカル仕様をマウント** — OpenAPIドキュメントをコンテナの/docsにマウント ## 主な機能 - OpenAPI 3.xとSwagger 2.0仕様から美しいAPIドキュメント生成 - ブラウザ内蔵エンドポイントテスト用APIクライアント - ダークモード対応の複数テーマ - ローカルファイルマウントまたはURL参照に対応 - 軽量な単一コンテナデプロイ ## ライセンス MIT — [GitHub](https://github.com/scalar/scalar) ko-KR: description: | Scalar는 OpenAPI/Swagger 사양에서 아름답고 인터랙티브한 API 문서를 생성하는 오픈소스 API 플랫폼입니다. 사양 파일을 마운트하거나 URL을 제공하면 브라우저 내장 API 클라이언트가 포함된 모던 API 레퍼런스를 사용할 수 있습니다. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: Scalar API Reference에 접속할 도메인 readme: | # Scalar API Reference OpenAPI/Swagger 사양을 아름다운 인터랙티브 API 문서로 변환하는 오픈소스 플랫폼. 내장 API 클라이언트로 브라우저에서 직접 엔드포인트를 테스트할 수 있습니다. ## 배포 후 할 수 있는 것 1. **도메인 접속** — 기본 Galaxy API 레퍼런스 확인 2. **사양 설정** — API_REFERENCE_CONFIG 환경 변수에 OpenAPI 사양 URL 설정 3. **엔드포인트 테스트** — 내장 API 클라이언트로 문서에서 직접 요청 4. **테마 커스터마이징** — 여러 색상 테마 중 선택 5. **로컬 사양 마운트** — OpenAPI 문서를 컨테이너 /docs에 마운트 ## 주요 기능 - OpenAPI 3.x 및 Swagger 2.0 사양에서 아름다운 API 문서 생성 - 브라우저 내장 엔드포인트 테스트용 API 클라이언트 - 다크 모드 지원 다중 테마 - 로컬 파일 마운트 또는 URL 참조 지원 - 경량 단일 컨테이너 배포 ## 라이선스 MIT — [GitHub](https://github.com/scalar/scalar) th-TH: description: | Scalar คือแพลตฟอร์ม API แบบโอเพ่นซอร์สที่สร้างเอกสาร API แบบอินเทอร์แอคทีฟจากสเปค OpenAPI/Swagger เมาท์ไฟล์สเปคหรือระบุ URL เพื่อรับเอกสารอ้างอิง API สมัยใหม่พร้อม API client ในตัวสำหรับทดสอบ endpoint โดยตรงในเบราว์เซอร์ variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง Scalar API Reference readme: | # Scalar API Reference แพลตฟอร์มโอเพ่นซอร์สที่แปลงสเปค OpenAPI/Swagger เป็นเอกสาร API แบบอินเทอร์แอคทีฟ มี API client ในตัวสำหรับทดสอบ endpoint โดยตรงในเบราว์เซอร์ ## สิ่งที่ทำได้หลังจากติดตั้ง 1. **เข้าสู่โดเมน** — ดูเอกสาร Galaxy API เริ่มต้น 2. **ตั้งค่าสเปค** — อัปเดต API_REFERENCE_CONFIG ด้วย URL สเปค OpenAPI ของคุณ 3. **ทดสอบ endpoint** — ใช้ API client ในตัวส่งคำขอจากเอกสาร 4. **ปรับแต่งธีม** — เลือกจากธีมสีหลากหลาย 5. **เมาท์สเปคในเครื่อง** — เมาท์เอกสาร OpenAPI ไปยัง /docs ในคอนเทนเนอร์ ## ฟีเจอร์หลัก - สร้างเอกสาร API จาก OpenAPI 3.x และ Swagger 2.0 - API client ในตัวสำหรับทดสอบ endpoint ในเบราว์เซอร์ - หลายตัวเลือกธีมพร้อมโหมดมืด - รองรับเมาท์ไฟล์ในเครื่องหรืออ้างอิง URL - ติดตั้งเบาในคอนเทนเนอร์เดียว ## สัญญาอนุญาต MIT — [GitHub](https://github.com/scalar/scalar) zh-CN: description: | Scalar 是开源 API 平台，可从 OpenAPI/Swagger 规格自动生成美观的交互式 API 文档。挂载规格文件或提供 URL，即可获得包含内置 API 客户端的现代 API 参考文档。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 Scalar API Reference 的域名 readme: | # Scalar API Reference 开源平台，将 OpenAPI/Swagger 规格转换为美观的交互式 API 文档。内置 API 客户端可直接在浏览器中测试端点。 ## 部署后可以做什么 1. **打开域名** — 查看默认的 Galaxy API 参考文档 2. **配置规格** — 更新 API_REFERENCE_CONFIG 环境变量，填入您的 OpenAPI 规格 URL 3. **测试端点** — 使用内置 API 客户端直接从文档发送请求 4. **自定义主题** — 从多种颜色主题中选择 5. **挂载本地规格** — 将 OpenAPI 文档挂载到容器的 /docs 目录 ## 主要功能 - 从 OpenAPI 3.x 和 Swagger 2.0 规格生成美观的 API 文档 - 内置浏览器端点测试的 API 客户端 - 多种主题选项，支持深色模式 - 支持挂载本地规格文件或引用 URL - 轻量级单容器部署 ## 授权 MIT — [GitHub](https://github.com/scalar/scalar) zh-TW: description: | Scalar 是開源 API 平台，可從 OpenAPI/Swagger 規格自動產生美觀的互動式 API 文件。掛載規格檔案或提供 URL，即可獲得包含內建 API 客戶端的現代化 API 參考文件。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 Scalar API Reference 的網域 readme: | # Scalar API Reference 開源平台，將 OpenAPI/Swagger 規格轉換為美觀的互動式 API 文件。內建 API 客戶端可直接在瀏覽器中測試端點。 ## 部署後可以做什麼 1. **開啟網域** — 查看預設的 Galaxy API 參考文件 2. **設定規格** — 更新 API_REFERENCE_CONFIG 環境變數，填入您的 OpenAPI 規格 URL 3. **測試端點** — 使用內建 API 客戶端直接從文件發送請求 4. **自訂主題** — 從多種色彩主題中選擇 5. **掛載本地規格** — 將 OpenAPI 文件掛載到容器的 /docs 目錄 ## 主要功能 - 從 OpenAPI 3.x 和 Swagger 2.0 規格產生美觀的 API 文件 - 內建瀏覽器端點測試的 API 客戶端 - 多種主題選項，支援深色模式 - 支援掛載本地規格檔案或引用 URL - 輕量級單一容器部署 ## 授權 MIT — [GitHub](https://github.com/scalar/scalar)