# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: Redoc spec: description: | Redoc is an OpenAPI/Swagger-generated API reference documentation viewer. It renders beautiful, responsive, and interactive API documentation from OpenAPI specification files with three-panel design and deep linking support. coverImage: https://raw.githubusercontent.com/Redocly/redoc/main/demo/redoc-demo.png icon: https://raw.githubusercontent.com/Redocly/redoc/main/docs/images/redoc.png variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access Redoc tags: - api - documentation - openapi readme: | # Redoc An open-source API documentation viewer that generates beautiful, responsive, and interactive documentation from OpenAPI (Swagger) specification files. ## What You Can Do After Deployment 1. **Visit your domain** — See the default Petstore API documentation rendered with Redoc 2. **Load your own spec** — Point Redoc to your OpenAPI/Swagger JSON or YAML spec URL via the SPEC_URL environment variable 3. **Explore the three-panel layout** — Navigate the left menu, center content, and right code samples 4. **Search the API** — Use the built-in search to quickly find endpoints and schemas 5. **Share deep links** — Copy URLs that link directly to specific endpoints or schemas ## Key Features - Three-panel responsive layout with menu, content, and code samples - Supports OpenAPI 3.1, 3.0, and Swagger 2.0 specifications - Interactive request/response examples with multiple language samples - Built-in search functionality across all endpoints and schemas - Deep linking to specific operations, tags, and schemas - Automatic code sample generation - Server-side rendering support for SEO - Customizable themes and branding options - Markdown support in descriptions - Mobile-friendly responsive design ## License MIT — [GitHub](https://github.com/Redocly/redoc) services: - name: redoc icon: https://raw.githubusercontent.com/Redocly/redoc/main/docs/images/redoc.png template: PREBUILT_V2 spec: source: image: redocly/redoc:v2.5.1 ports: - id: web port: 80 type: HTTP env: SPEC_URL: default: https://petstore3.swagger.io/api/v3/openapi.json expose: true healthCheck: type: HTTP port: web http: path: / domainKey: PUBLIC_DOMAIN localization: es-ES: description: | Redoc es un visor de documentación de referencia de API generado por OpenAPI/Swagger. Renderiza documentación de API hermosa, responsiva e interactiva a partir de archivos de especificación OpenAPI con diseño de tres paneles y soporte de enlaces profundos. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a Redoc readme: | # Redoc Un visor de documentación de API de código abierto que genera documentación hermosa, responsiva e interactiva a partir de archivos de especificación OpenAPI (Swagger). ## Qué puedes hacer después del despliegue 1. **Visita tu dominio** — Ve la documentación predeterminada de la API Petstore renderizada con Redoc 2. **Carga tu propia especificación** — Apunta Redoc a tu URL de especificación OpenAPI/Swagger JSON o YAML mediante la variable de entorno SPEC_URL 3. **Explora el diseño de tres paneles** — Navega por el menú izquierdo, el contenido central y los ejemplos de código a la derecha 4. **Busca en la API** — Usa la búsqueda integrada para encontrar rápidamente endpoints y esquemas 5. **Comparte enlaces profundos** — Copia URLs que enlazan directamente a endpoints o esquemas específicos ## Características principales - Diseño responsivo de tres paneles con menú, contenido y ejemplos de código - Compatible con especificaciones OpenAPI 3.1, 3.0 y Swagger 2.0 - Ejemplos de solicitud/respuesta interactivos con muestras en múltiples lenguajes - Funcionalidad de búsqueda integrada en todos los endpoints y esquemas - Enlaces profundos a operaciones, etiquetas y esquemas específicos - Generación automática de ejemplos de código - Soporte de renderizado del lado del servidor para SEO - Temas y opciones de marca personalizables - Soporte de Markdown en descripciones - Diseño responsivo compatible con dispositivos móviles ## Licencia MIT — [GitHub](https://github.com/Redocly/redoc) id-ID: description: | Redoc adalah penampil dokumentasi referensi API yang dihasilkan dari OpenAPI/Swagger. Merender dokumentasi API yang indah, responsif, dan interaktif dari file spesifikasi OpenAPI dengan desain tiga panel dan dukungan deep link. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses Redoc readme: | # Redoc Penampil dokumentasi API open-source yang menghasilkan dokumentasi indah, responsif, dan interaktif dari file spesifikasi OpenAPI (Swagger). ## Yang Dapat Dilakukan Setelah Deploy 1. **Kunjungi domain Anda** — Lihat dokumentasi API Petstore default yang dirender dengan Redoc 2. **Muat spesifikasi Anda** — Arahkan Redoc ke URL spesifikasi OpenAPI/Swagger JSON atau YAML melalui variabel lingkungan SPEC_URL 3. **Jelajahi tata letak tiga panel** — Navigasi menu kiri, konten tengah, dan contoh kode kanan 4. **Cari API** — Gunakan pencarian bawaan untuk menemukan endpoint dan skema dengan cepat 5. **Bagikan deep link** — Salin URL yang menghubungkan langsung ke endpoint atau skema tertentu ## Fitur Utama - Tata letak responsif tiga panel dengan menu, konten, dan contoh kode - Mendukung spesifikasi OpenAPI 3.1, 3.0, dan Swagger 2.0 - Contoh permintaan/respons interaktif dengan sampel multi-bahasa - Fungsi pencarian bawaan di semua endpoint dan skema - Deep link ke operasi, tag, dan skema tertentu - Pembuatan contoh kode otomatis - Dukungan rendering sisi server untuk SEO - Tema dan opsi branding yang dapat dikustomisasi - Dukungan Markdown dalam deskripsi - Desain responsif ramah perangkat mobile ## Lisensi MIT — [GitHub](https://github.com/Redocly/redoc) ja-JP: description: | Redoc は OpenAPI/Swagger 生成の API リファレンスドキュメントビューアーです。OpenAPI 仕様ファイルから美しく、レスポンシブでインタラクティブな API ドキュメントを生成し、3パネルデザインとディープリンクをサポートします。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: Redoc にアクセスするためのドメイン readme: | # Redoc OpenAPI（Swagger）仕様ファイルから美しく、レスポンシブでインタラクティブなドキュメントを生成するオープンソース API ドキュメントビューアーです。 ## デプロイ後にできること 1. **ドメインにアクセス** — Redoc でレンダリングされたデフォルトの Petstore API ドキュメントを確認 2. **独自の仕様をロード** — SPEC_URL 環境変数で OpenAPI/Swagger JSON または YAML 仕様の URL を指定 3. **3パネルレイアウトを探索** — 左メニュー、中央コンテンツ、右コードサンプルをナビゲート 4. **API を検索** — 内蔵検索でエンドポイントやスキーマを素早く検索 5. **ディープリンクを共有** — 特定のエンドポイントやスキーマに直接リンクする URL をコピー ## 主な機能 - メニュー、コンテンツ、コードサンプルを含む3パネルレスポンシブレイアウト - OpenAPI 3.1、3.0、Swagger 2.0 仕様をサポート - 複数言語サンプル付きのインタラクティブなリクエスト/レスポンス例 - すべてのエンドポイントとスキーマにわたる内蔵検索機能 - 特定のオペレーション、タグ、スキーマへのディープリンク - 自動コードサンプル生成 - SEO のためのサーバーサイドレンダリングサポート - カスタマイズ可能なテーマとブランディングオプション - 説明での Markdown サポート - モバイルフレンドリーなレスポンシブデザイン ## ライセンス MIT — [GitHub](https://github.com/Redocly/redoc) ko-KR: description: | Redoc은 OpenAPI/Swagger 생성 API 참조 문서 뷰어입니다. OpenAPI 사양 파일에서 아름답고 반응형이며 인터랙티브한 API 문서를 생성하며, 3패널 디자인과 딥링크를 지원합니다. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: Redoc에 접속할 도메인 readme: | # Redoc OpenAPI(Swagger) 사양 파일에서 아름답고 반응형이며 인터랙티브한 문서를 생성하는 오픈소스 API 문서 뷰어입니다. ## 배포 후 할 수 있는 것 1. **도메인 방문** — Redoc으로 렌더링된 기본 Petstore API 문서 확인 2. **자체 사양 로드** — SPEC_URL 환경 변수를 통해 OpenAPI/Swagger JSON 또는 YAML 사양 URL 지정 3. **3패널 레이아웃 탐색** — 왼쪽 메뉴, 중앙 콘텐츠, 오른쪽 코드 샘플 탐색 4. **API 검색** — 내장 검색으로 엔드포인트와 스키마를 빠르게 검색 5. **딥링크 공유** — 특정 엔드포인트나 스키마에 직접 링크하는 URL 복사 ## 주요 기능 - 메뉴, 콘텐츠, 코드 샘플이 포함된 3패널 반응형 레이아웃 - OpenAPI 3.1, 3.0, Swagger 2.0 사양 지원 - 다국어 샘플이 포함된 인터랙티브 요청/응답 예제 - 모든 엔드포인트와 스키마에 걸친 내장 검색 기능 - 특정 오퍼레이션, 태그, 스키마에 대한 딥링크 - 자동 코드 샘플 생성 - SEO를 위한 서버 사이드 렌더링 지원 - 커스터마이즈 가능한 테마 및 브랜딩 옵션 - 설명에서 Markdown 지원 - 모바일 친화적 반응형 디자인 ## 라이선스 MIT — [GitHub](https://github.com/Redocly/redoc) th-TH: description: | Redoc เป็นตัวแสดงเอกสารอ้างอิง API ที่สร้างจาก OpenAPI/Swagger เรนเดอร์เอกสาร API ที่สวยงาม ตอบสนอง และโต้ตอบได้จากไฟล์สเปค OpenAPI พร้อมดีไซน์สามแผงและรองรับ deep link variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง Redoc readme: | # Redoc ตัวแสดงเอกสาร API แบบโอเพนซอร์สที่สร้างเอกสารสวยงาม ตอบสนอง และโต้ตอบได้จากไฟล์สเปค OpenAPI (Swagger) ## สิ่งที่ทำได้หลังการ Deploy 1. **เยี่ยมชมโดเมนของคุณ** — ดูเอกสาร Petstore API เริ่มต้นที่เรนเดอร์ด้วย Redoc 2. **โหลดสเปคของคุณ** — ชี้ Redoc ไปยัง URL สเปค OpenAPI/Swagger JSON หรือ YAML ผ่านตัวแปรสภาพแวดล้อม SPEC_URL 3. **สำรวจเลย์เอาต์สามแผง** — นำทางเมนูซ้าย เนื้อหาตรงกลาง และตัวอย่างโค้ดด้านขวา 4. **ค้นหา API** — ใช้การค้นหาในตัวเพื่อค้นหา endpoint และ schema อย่างรวดเร็ว 5. **แชร์ deep link** — คัดลอก URL ที่ลิงก์โดยตรงไปยัง endpoint หรือ schema เฉพาะ ## ฟีเจอร์หลัก - เลย์เอาต์ตอบสนองสามแผง พร้อมเมนู เนื้อหา และตัวอย่างโค้ด - รองรับสเปค OpenAPI 3.1, 3.0 และ Swagger 2.0 - ตัวอย่างคำขอ/การตอบกลับแบบโต้ตอบพร้อมตัวอย่างหลายภาษา - ฟังก์ชันค้นหาในตัวครอบคลุมทุก endpoint และ schema - Deep link ไปยังการดำเนินการ แท็ก และ schema เฉพาะ - สร้างตัวอย่างโค้ดอัตโนมัติ - รองรับการเรนเดอร์ฝั่งเซิร์ฟเวอร์สำหรับ SEO - ธีมและตัวเลือกแบรนดิ้งที่ปรับแต่งได้ - รองรับ Markdown ในคำอธิบาย - ดีไซน์ตอบสนองเป็นมิตรกับมือถือ ## สัญญาอนุญาต MIT — [GitHub](https://github.com/Redocly/redoc) zh-CN: description: | Redoc 是一款 OpenAPI/Swagger 生成的 API 参考文档查看器。它从 OpenAPI 规格文件生成美观、响应式且交互的 API 文档，具备三栏式设计和深层链接支持。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 Redoc 的域名 readme: | # Redoc 一款开源 API 文档查看器，从 OpenAPI（Swagger）规格文件生成美观、响应式且交互的文档。 ## 部署后可以做什么 1. **打开您的域名** — 查看以 Redoc 渲染的默认 Petstore API 文档 2. **加载您自己的规格** — 通过 SPEC_URL 环境变量将 Redoc 指向您的 OpenAPI/Swagger JSON 或 YAML 规格 URL 3. **探索三栏式布局** — 浏览左侧菜单、中间内容和右侧代码示例 4. **搜索 API** — 使用内置搜索快速找到端点和结构描述 5. **分享深层链接** — 复制直接链接到特定端点或结构描述的 URL ## 主要功能 - 三栏式响应式布局，包含菜单、内容和代码示例 - 支持 OpenAPI 3.1、3.0 和 Swagger 2.0 规格 - 交互式请求/响应示例，支持多种编程语言 - 内置搜索功能，覆盖所有端点和结构描述 - 深层链接至特定操作、标签和结构描述 - 自动代码示例生成 - 支持服务器端渲染以利 SEO - 可自定义主题和品牌选项 - 描述中支持 Markdown - 移动端友好的响应式设计 ## 许可证 MIT — [GitHub](https://github.com/Redocly/redoc) zh-TW: description: | Redoc 是一款 OpenAPI/Swagger 生成的 API 參考文件檢視器。它從 OpenAPI 規格檔案生成美觀、響應式且互動的 API 文件，具備三欄式設計和深層連結支援。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 Redoc 的網域 readme: | # Redoc 一款開源 API 文件檢視器，從 OpenAPI（Swagger）規格檔案生成美觀、響應式且互動的文件。 ## 部署後可以做什麼 1. **開啟您的網域** — 查看以 Redoc 呈現的預設 Petstore API 文件 2. **載入您自己的規格** — 透過 SPEC_URL 環境變數將 Redoc 指向您的 OpenAPI/Swagger JSON 或 YAML 規格 URL 3. **探索三欄式版面** — 瀏覽左側選單、中間內容和右側程式碼範例 4. **搜尋 API** — 使用內建搜尋快速找到端點和結構描述 5. **分享深層連結** — 複製直接連結到特定端點或結構描述的 URL ## 主要功能 - 三欄式響應式版面，包含選單、內容和程式碼範例 - 支援 OpenAPI 3.1、3.0 和 Swagger 2.0 規格 - 互動式請求/回應範例，支援多種程式語言 - 內建搜尋功能，涵蓋所有端點和結構描述 - 深層連結至特定操作、標籤和結構描述 - 自動程式碼範例生成 - 支援伺服器端渲染以利 SEO - 可自訂主題和品牌選項 - 描述中支援 Markdown - 行動裝置友善的響應式設計 ## 授權條款 MIT — [GitHub](https://github.com/Redocly/redoc)