# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: Swagger Editor spec: description: | Swagger Editor is a browser-based editor for designing and documenting APIs using the OpenAPI and AsyncAPI specifications. It provides real-time validation, syntax highlighting, and instant preview of your API documentation side by side. coverImage: https://static1.smartbear.co/swagger/media/images/tools/opensource/swagger-editor.png icon: https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWE-logo-clr.png variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access Swagger Editor tags: - Tool - Development readme: | # Swagger Editor A browser-based editor for designing and documenting APIs with the OpenAPI and AsyncAPI specifications. Write your API definition on the left and see rendered documentation on the right in real time. ## What You Can Do After Deployment 1. **Open your domain** — Swagger Editor is ready to use immediately, no login required 2. **Write API definitions** — create OpenAPI 3.x or AsyncAPI specs with syntax highlighting 3. **Validate in real time** — errors and warnings appear instantly as you type 4. **Preview documentation** — see rendered, interactive API docs side by side 5. **Import and export** — load existing specs from URL or file, export as YAML or JSON ## Key Features - Full support for OpenAPI 3.0, 3.1, and AsyncAPI 2.x - Real-time validation with detailed error messages - Syntax highlighting powered by Monaco Editor - Side-by-side editor and documentation preview - Import specs from URL, file upload, or clipboard - Export as YAML or JSON - Try-it-out functionality to test API endpoints directly - No database or account required — fully stateless ## License Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) services: - name: swagger-editor icon: https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWE-logo-clr.png template: PREBUILT_V2 spec: id: swagger-editor source: image: swaggerapi/swagger-editor:v5.3.1 ports: - id: web port: 8080 type: HTTP env: {} healthCheck: type: HTTP port: web http: path: / domainKey: PUBLIC_DOMAIN localization: es-ES: description: | Swagger Editor es un editor en el navegador para diseñar y documentar APIs usando las especificaciones OpenAPI y AsyncAPI. Ofrece validación en tiempo real, resaltado de sintaxis y vista previa instantánea de la documentación. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a Swagger Editor readme: | # Swagger Editor Editor en el navegador para diseñar y documentar APIs con las especificaciones OpenAPI y AsyncAPI. Escribe la definición de tu API a la izquierda y ve la documentación renderizada a la derecha en tiempo real. ## Qué puedes hacer después del despliegue 1. **Visita tu dominio** — Swagger Editor está listo, no requiere inicio de sesión 2. **Escribe definiciones de API** — crea especificaciones OpenAPI 3.x o AsyncAPI con resaltado de sintaxis 3. **Validación en tiempo real** — errores y advertencias aparecen al instante mientras escribes 4. **Vista previa de documentación** — ve documentación interactiva de API lado a lado 5. **Importa y exporta** — carga especificaciones desde URL o archivo, exporta como YAML o JSON ## Licencia Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) id-ID: description: | Swagger Editor adalah editor berbasis browser untuk mendesain dan mendokumentasikan API menggunakan spesifikasi OpenAPI dan AsyncAPI. Menyediakan validasi real-time, penyorotan sintaks, dan pratinjau dokumentasi secara berdampingan. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses Swagger Editor readme: | # Swagger Editor Editor berbasis browser untuk mendesain dan mendokumentasikan API dengan spesifikasi OpenAPI dan AsyncAPI. Tulis definisi API di sisi kiri dan lihat dokumentasi yang dirender di sisi kanan secara real-time. ## Apa yang bisa dilakukan setelah deploy 1. **Buka domain** — Swagger Editor langsung siap digunakan, tanpa login 2. **Tulis definisi API** — buat spesifikasi OpenAPI 3.x atau AsyncAPI dengan penyorotan sintaks 3. **Validasi real-time** — error dan peringatan muncul langsung saat mengetik 4. **Pratinjau dokumentasi** — lihat dokumentasi API interaktif secara berdampingan 5. **Impor dan ekspor** — muat spesifikasi dari URL atau file, ekspor sebagai YAML atau JSON ## Lisensi Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) ja-JP: description: | Swagger Editor はブラウザベースの API 設計・ドキュメント編集ツールです。OpenAPI と AsyncAPI 仕様に対応し、リアルタイムバリデーションとドキュメントの並列プレビューを提供します。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: Swagger Editor にアクセスするためのドメイン readme: | # Swagger Editor ブラウザベースの API 設計・ドキュメント編集ツール。OpenAPI と AsyncAPI 仕様に対応。左側で API 定義を記述し、右側でリアルタイムにレンダリングされたドキュメントを確認できます。 ## デプロイ後にできること 1. **ドメインにアクセス** — ログイン不要ですぐに使えます 2. **API 定義を作成** — シンタックスハイライト付きで OpenAPI 3.x や AsyncAPI を記述 3. **リアルタイム検証** — 入力中にエラーや警告が即座に表示 4. **ドキュメントをプレビュー** — インタラクティブな API ドキュメントを並列表示 5. **インポート・エクスポート** — URL やファイルから仕様を読み込み、YAML や JSON で出力 ## ライセンス Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) ko-KR: description: | Swagger Editor는 브라우저 기반 API 설계 및 문서 편집기입니다. OpenAPI와 AsyncAPI 사양을 지원하며, 실시간 유효성 검사와 문서 미리보기를 나란히 제공합니다. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: Swagger Editor에 접속할 도메인 readme: | # Swagger Editor 브라우저 기반 API 설계 및 문서 편집기. OpenAPI와 AsyncAPI 사양을 지원합니다. 왼쪽에서 API 정의를 작성하고 오른쪽에서 실시간으로 렌더링된 문서를 확인할 수 있습니다. ## 배포 후 할 수 있는 것 1. **도메인 접속** — 로그인 없이 바로 사용 가능 2. **API 정의 작성** — 구문 강조로 OpenAPI 3.x 또는 AsyncAPI 사양 작성 3. **실시간 검증** — 입력 중 오류 및 경고 즉시 표시 4. **문서 미리보기** — 대화형 API 문서를 나란히 확인 5. **가져오기/내보내기** — URL이나 파일에서 사양 로드, YAML 또는 JSON으로 내보내기 ## 라이선스 Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) th-TH: description: | Swagger Editor เป็นเครื่องมือแก้ไขบนเบราว์เซอร์สำหรับออกแบบและจัดทำเอกสาร API ด้วยสเปค OpenAPI และ AsyncAPI รองรับการตรวจสอบแบบเรียลไทม์ ไฮไลต์ซินแทกซ์ และการแสดงตัวอย่างเอกสารแบบเคียงข้างกัน variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง Swagger Editor readme: | # Swagger Editor เครื่องมือแก้ไขบนเบราว์เซอร์สำหรับออกแบบและจัดทำเอกสาร API ด้วยสเปค OpenAPI และ AsyncAPI เขียนคำจำกัดความ API ด้านซ้ายและดูเอกสารที่เรนเดอร์แล้วด้านขวาแบบเรียลไทม์ ## สิ่งที่ทำได้หลังจากติดตั้ง 1. **เข้าสู่โดเมน** — Swagger Editor พร้อมใช้ทันที ไม่ต้องเข้าสู่ระบบ 2. **เขียนคำจำกัดความ API** — สร้างสเปค OpenAPI 3.x หรือ AsyncAPI พร้อมไฮไลต์ซินแทกซ์ 3. **ตรวจสอบแบบเรียลไทม์** — ข้อผิดพลาดและคำเตือนแสดงทันทีขณะพิมพ์ 4. **แสดงตัวอย่างเอกสาร** — ดูเอกสาร API แบบโต้ตอบเคียงข้างกัน 5. **นำเข้าและส่งออก** — โหลดสเปคจาก URL หรือไฟล์ ส่งออกเป็น YAML หรือ JSON ## สัญญาอนุญาต Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) zh-CN: description: | Swagger Editor 是浏览器版的 API 设计与文档编辑器，支持 OpenAPI 和 AsyncAPI 规范。提供实时验证、语法高亮，以及 API 文档的即时并排预览。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 Swagger Editor 的域名 readme: | # Swagger Editor 浏览器版的 API 设计与文档编辑器，支持 OpenAPI 和 AsyncAPI 规范。左侧编写 API 定义，右侧实时显示渲染后的文档。 ## 部署后可以做什么 1. **打开域名** — Swagger Editor 立即可用，无需登录 2. **编写 API 定义** — 使用语法高亮创建 OpenAPI 3.x 或 AsyncAPI 规范 3. **实时验证** — 输入时立即显示错误与警告 4. **预览文档** — 并排查看渲染后的交互式 API 文档 5. **导入导出** — 从 URL 或文件加载规范，导出为 YAML 或 JSON ## 授权 Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor) zh-TW: description: | Swagger Editor 是瀏覽器版的 API 設計與文件編輯器，支援 OpenAPI 和 AsyncAPI 規範。提供即時驗證、語法高亮，以及 API 文件的即時並排預覽。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 Swagger Editor 的網域 readme: | # Swagger Editor 瀏覽器版的 API 設計與文件編輯器，支援 OpenAPI 和 AsyncAPI 規範。左側撰寫 API 定義，右側即時顯示渲染後的文件。 ## 部署後可以做什麼 1. **開啟網域** — Swagger Editor 立即可用，無需登入 2. **撰寫 API 定義** — 使用語法高亮建立 OpenAPI 3.x 或 AsyncAPI 規範 3. **即時驗證** — 輸入時立即顯示錯誤與警告 4. **預覽文件** — 並排檢視渲染後的互動式 API 文件 5. **匯入匯出** — 從 URL 或檔案載入規範，匯出為 YAML 或 JSON ## 授權 Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-editor)