Files
SnapOtter/apps/docs/zh-TW/tools/files/yaml-json.md
T
SnapOtterandGitHub 4963ab3bbd feat(docs-i18n): translate all documentation into 20 languages
All 181 docs markdown files translated into 20 languages (apps/docs/<locale>/**). Companion to the i18n code PR; admin-merged because the file count exceeds GitHub's per-PR CI trigger limit. Validated by pnpm i18n:check (all surfaces, 0 stale/missing) and a clean all-locale docs build.
2026-07-11 13:52:47 +08:00

1.5 KiB
Raw Blame History

description, i18n_source_hash, i18n_provenance, i18n_output_hash
description i18n_source_hash i18n_provenance i18n_output_hash
在 YAML 與 JSON 之間雙向轉換。 acf8ca21ee99 human 53f7c91d3528

YAML / JSON

在 YAML 與 JSON 格式之間雙向轉換。上傳 YAML 檔案可取得 JSON,或上傳 JSON 檔案可取得 YAML。

API Endpoint

POST /api/v1/tools/files/yaml-json

接受包含 YAML 或 JSON 檔案的 multipart form data。不需要 settings 欄位。

Parameters

此工具沒有可設定的參數。轉換方向由輸入檔案的副檔名決定。

Example Request

YAML 轉 JSON

curl -X POST http://localhost:1349/api/v1/tools/files/yaml-json \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@config.yaml"

JSON 轉 YAML

curl -X POST http://localhost:1349/api/v1/tools/files/yaml-json \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@config.json"

Example Response

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/config.json",
  "originalSize": 620,
  "processedSize": 780
}

Notes

  • 轉換方向會從輸入檔案的副檔名自動偵測:.yaml.yml 會產生 .json,而 .json 會產生 .yaml
  • .yaml.yml 兩種副檔名皆可接受。
  • 在多文件的 YAML 檔案中,只會轉換第一個文件;以 --- 分隔的其他文件會被忽略。