# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: Swagger-UI spec: description: | Swagger UI renders OpenAPI specifications as interactive API documentation. Explore endpoints, try requests, and inspect responses directly from your browser. No database required — just point it at your API spec. coverImage: https://github.com/swagger-api.png icon: https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access Swagger UI tags: - Tool - Developer readme: | # Swagger UI Swagger UI renders OpenAPI (formerly Swagger) specifications as interactive API documentation. Paste or host your OpenAPI JSON/YAML spec and explore endpoints, try live requests, and inspect responses — all from your browser. ## What You Can Do After Deployment Visit your domain to see the default Petstore API demo. To use your own API spec, set the `SWAGGER_JSON_URL` environment variable. **Interactive documentation:** Browse API endpoints organized by tags. Expand any operation to see parameters, request bodies, and response schemas. **Try it out:** Execute real API requests directly from the documentation. Fill in parameters, set headers, and see live responses. **Multiple specs:** Switch between different API specifications using the URL bar at the top of the page. **Authentication:** Configure API keys, OAuth 2.0, or Bearer tokens to test authenticated endpoints. **Deep linking:** Share links to specific operations. URLs update as you navigate. ## Configuration - **Custom API spec:** Set `SWAGGER_JSON_URL` in Zeabur's **Service > Variables** to point to your OpenAPI spec URL (e.g., `https://api.example.com/openapi.json`). - **Local spec file:** Mount a spec file to `/usr/share/nginx/html/swagger.json` and set `SWAGGER_JSON` to `/swagger.json`. - **Base URL:** Set `BASE_URL` to serve Swagger UI at a subpath (e.g., `/docs`). ## License Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) services: - name: swagger-ui icon: https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/favicon-32x32.png template: PREBUILT_V2 spec: source: image: swaggerapi/swagger-ui:v5.32.1 ports: - id: web port: 8080 type: HTTP env: SWAGGER_JSON_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: | Swagger UI renderiza especificaciones OpenAPI como documentación interactiva de API. Explora endpoints, prueba solicitudes e inspecciona respuestas directamente desde tu navegador. Sin base de datos. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a Swagger UI readme: | # Swagger UI Renderiza especificaciones OpenAPI como documentación interactiva. Explora endpoints, ejecuta solicitudes y verifica respuestas desde el navegador. ## Después del despliegue Visita tu dominio para ver la demo de Petstore API. Configura `SWAGGER_JSON_URL` para usar tu propia especificación. **Documentación interactiva:** Navega endpoints por etiquetas. Expande operaciones para ver parámetros y esquemas. **Prueba en vivo:** Ejecuta solicitudes API reales directamente desde la documentación. ## Configuración - Establece `SWAGGER_JSON_URL` en **Service > Variables** de Zeabur. ## Licencia Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) id-ID: description: | Swagger UI merender spesifikasi OpenAPI menjadi dokumentasi API interaktif. Jelajahi endpoint, coba request, dan periksa response langsung dari browser. Tanpa database. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses Swagger UI readme: | # Swagger UI Merender spesifikasi OpenAPI menjadi dokumentasi API interaktif. Jelajahi endpoint, jalankan request, dan periksa response dari browser. ## Setelah Deploy Kunjungi domain untuk melihat demo Petstore API default. Atur `SWAGGER_JSON_URL` untuk menggunakan spesifikasi API Anda sendiri. **Dokumentasi interaktif:** Telusuri endpoint API berdasarkan tag. **Uji langsung:** Jalankan request API nyata langsung dari dokumentasi. ## Konfigurasi - Atur `SWAGGER_JSON_URL` di **Service > Variables** Zeabur. ## Lisensi Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) ja-JP: description: | Swagger UIはOpenAPI仕様をインタラクティブなAPIドキュメントとしてレンダリングします。ブラウザから直接エンドポイントを探索し、リクエストを試し、レスポンスを確認できます。データベース不要。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: Swagger UIにアクセスするためのドメイン readme: | # Swagger UI OpenAPI仕様をインタラクティブなAPIドキュメントとしてレンダリング。エンドポイントの探索、リクエストの実行、レスポンスの確認がブラウザで完結。 ## デプロイ後にできること ドメインにアクセスするとデフォルトのPetstore APIデモが表示されます。`SWAGGER_JSON_URL`環境変数で独自のAPI仕様を指定できます。 **インタラクティブドキュメント：** タグごとにAPIエンドポイントを閲覧。パラメータとレスポンススキーマを確認。 **テスト実行：** ドキュメントから直接APIリクエストを実行。 ## 設定 - Zeaburの**Service > Variables**で`SWAGGER_JSON_URL`を設定。 ## ライセンス Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) ko-KR: description: | Swagger UI는 OpenAPI 사양을 인터랙티브 API 문서로 렌더링합니다. 브라우저에서 직접 엔드포인트를 탐색하고 요청을 테스트하고 응답을 확인하세요. 데이터베이스 불필요. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: Swagger UI에 접속할 도메인 readme: | # Swagger UI OpenAPI 사양을 인터랙티브 API 문서로 렌더링. 엔드포인트 탐색, 실시간 요청 실행, 응답 확인을 브라우저에서 수행. ## 배포 후 할 수 있는 것 도메인에 접속하면 기본 Petstore API 데모가 표시됩니다. `SWAGGER_JSON_URL` 환경변수로 자체 API 사양을 지정하세요. **인터랙티브 문서:** 태그별로 API 엔드포인트 탐색. **실시간 테스트:** 문서에서 직접 API 요청 실행. ## 설정 - Zeabur의 **Service > Variables**에서 `SWAGGER_JSON_URL` 설정. ## 라이선스 Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) th-TH: description: | Swagger UI แสดงสเปค OpenAPI เป็นเอกสาร API แบบโต้ตอบ สำรวจ endpoint ลองส่ง request และตรวจสอบ response จากเบราว์เซอร์โดยตรง ไม่ต้องใช้ฐานข้อมูล variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง Swagger UI readme: | # Swagger UI แสดงสเปค OpenAPI เป็นเอกสาร API แบบโต้ตอบ สำรวจ endpoint ส่ง request และตรวจสอบ response จากเบราว์เซอร์ ## หลังจากติดตั้ง เข้าชมโดเมนเพื่อดูตัวอย่าง Petstore API ตั้งค่า `SWAGGER_JSON_URL` เพื่อใช้สเปค API ของคุณเอง ## การตั้งค่า - ตั้งค่า `SWAGGER_JSON_URL` ใน **Service > Variables** ของ Zeabur ## สัญญาอนุญาต Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) zh-CN: description: | Swagger UI 将 OpenAPI 规格渲染为交互式 API 文档。直接在浏览器中浏览端点、尝试请求并检查响应。无需数据库。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 Swagger UI 的域名 readme: | # Swagger UI 将 OpenAPI 规格渲染为交互式 API 文档。浏览端点、执行实时请求、检查响应。 ## 部署后可以做什么 访问域名查看默认的 Petstore API 示例。设置 `SWAGGER_JSON_URL` 环境变量使用自己的 API 规格。 **交互式文档：** 浏览 API 端点，展开操作查看参数和响应结构。 **即时测试：** 直接从文档执行真实 API 请求。 ## 配置 - 在 Zeabur 的 **Service > Variables** 中设置 `SWAGGER_JSON_URL`。 ## 授权 Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui) zh-TW: description: | Swagger UI 將 OpenAPI 規格渲染為互動式 API 文件。直接在瀏覽器中瀏覽端點、嘗試請求並檢查回應。不需要資料庫——只需指向你的 API 規格即可。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 Swagger UI 的網域 readme: | # Swagger UI 將 OpenAPI 規格渲染為互動式 API 文件。瀏覽端點、執行即時請求、檢查回應——全部在瀏覽器中完成。 ## 部署後可以做什麼 開啟網域即可看到預設的 Petstore API 範例。要使用自己的 API 規格，請設定 `SWAGGER_JSON_URL` 環境變數。 **互動式文件：** 按標籤瀏覽 API 端點，展開操作查看參數和回應結構。 **立即測試：** 直接從文件中執行真實的 API 請求，填入參數並查看回應。 **驗證：** 設定 API 金鑰、OAuth 2.0 或 Bearer Token 來測試需要驗證的端點。 ## 設定 - 在 Zeabur 的 **Service > Variables** 中設定 `SWAGGER_JSON_URL` 指向你的 OpenAPI 規格 URL。 ## 授權 Apache-2.0 — [GitHub](https://github.com/swagger-api/swagger-ui)