mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
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.
This commit is contained in:
SnapOtter
@@ -0,0 +1,53 @@
|
||||
---
|
||||
description: "CSV または JSON データから棒グラフ、折れ線グラフ、円グラフを作成します。"
|
||||
i18n_source_hash: d3c39384457b
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: b6354341fb47
|
||||
---
|
||||
|
||||
# Chart Maker {#chart-maker}
|
||||
|
||||
CSV または JSON データから棒グラフ、折れ線グラフ、円グラフを作成します。描画されたグラフの PNG 画像を返します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/chart-maker`
|
||||
|
||||
CSV または JSON ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| kind | string | No | `"bar"` | グラフの種類: `bar`、`line`、`pie` |
|
||||
| title | string | No | - | グラフのタイトル（最大 120 文字） |
|
||||
| width | integer | No | `960` | グラフの幅（ピクセル、320〜2048） |
|
||||
| height | integer | No | `540` | グラフの高さ（ピクセル、240〜1536） |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/chart-maker \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@sales.csv" \
|
||||
-F 'settings={"kind": "line", "title": "Monthly Sales", "width": 960, "height": 540}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sales_chart.png",
|
||||
"originalSize": 1024,
|
||||
"processedSize": 48500
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 入力は `.csv` または `.json` ファイルである必要があります。CSV ファイルには列名を含むヘッダー行が必要です。
|
||||
- 最初の列がカテゴリラベルとして使用され、2 番目の列は数値である必要があり、データ値を提供します。使用されるのは 2 列のみです。
|
||||
- JSON 入力は `{label, value}` オブジェクトの配列、またはキーがラベルに、値がデータポイントになるプレーンオブジェクトである必要があります。
|
||||
- データポイントは最大 100 個です。すべての値は 0 以上である必要があります。
|
||||
- 入力形式にかかわらず、出力は常に PNG 画像です。
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "Word、OpenDocument、RTF、プレーンテキストの各形式間で変換します。"
|
||||
i18n_source_hash: 89771292569d
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 2826c28b6daa
|
||||
---
|
||||
|
||||
# Convert Document {#convert-document}
|
||||
|
||||
LibreOffice を使用して、ドキュメントを Word（DOCX）、OpenDocument（ODT）、RTF、プレーンテキストの各形式間で変換します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/convert-document`
|
||||
|
||||
Word／ODT／RTF／TXT ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Yes | - | 出力形式: `docx`、`odt`、`rtf`、`txt` |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/convert-document \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@report.docx" \
|
||||
-F 'settings={"format": "odt"}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。`/api/v1/jobs/{jobId}/progress` の SSE で進捗を追跡します。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.docx`、`.doc`、`.odt`、`.rtf`、`.txt`。
|
||||
- 変換はサーバー上でヘッドレスで動作する LibreOffice によって処理されます。
|
||||
- 複雑な書式（マクロ、埋め込みオブジェクト）は形式間の変換で保持されないことがあります。
|
||||
- 出力形式は入力形式と異なる必要があります。
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "PowerPoint と OpenDocument プレゼンテーション形式間で変換します。"
|
||||
i18n_source_hash: 08ba415d39ac
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 042e80a39e0b
|
||||
---
|
||||
|
||||
# Convert Presentation {#convert-presentation}
|
||||
|
||||
プレゼンテーションを PowerPoint（PPTX）と OpenDocument Presentation（ODP）形式間で変換します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/convert-presentation`
|
||||
|
||||
PowerPoint／ODP ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Yes | - | 出力形式: `pptx`、`odp` |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/convert-presentation \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@slides.pptx" \
|
||||
-F 'settings={"format": "odp"}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。`/api/v1/jobs/{jobId}/progress` の SSE で進捗を追跡します。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.pptx`、`.ppt`、`.odp`。
|
||||
- 変換はサーバー上でヘッドレスで動作する LibreOffice によって処理されます。
|
||||
- アニメーションや切り替え効果は形式間で保持されないことがあります。
|
||||
- 出力形式は入力形式と異なる必要があります。
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "Excel、OpenDocument、CSV の各形式間で変換します。"
|
||||
i18n_source_hash: b813b1b06962
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: da76438c661c
|
||||
---
|
||||
|
||||
# Convert Spreadsheet {#convert-spreadsheet}
|
||||
|
||||
スプレッドシートを Excel（XLSX）、OpenDocument Spreadsheet（ODS）、CSV の各形式間で変換します。複数シートのブックは、CSV に変換する際に最初のシートをエクスポートします。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/convert-spreadsheet`
|
||||
|
||||
Excel／ODS／CSV ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Yes | - | 出力形式: `xlsx`、`ods`、`csv` |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/convert-spreadsheet \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@data.xlsx" \
|
||||
-F 'settings={"format": "csv"}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。`/api/v1/jobs/{jobId}/progress` の SSE で進捗を追跡します。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.xlsx`、`.xls`、`.ods`、`.csv`。
|
||||
- 複数シートのブックを CSV に変換する場合、最初のシートのみがエクスポートされます。
|
||||
- 数式は評価され、CSV 出力では静的な値としてエクスポートされます。
|
||||
- 出力形式は入力形式と異なる必要があります。
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
description: "複数のファイルを 1 つの ZIP アーカイブにまとめます。"
|
||||
i18n_source_hash: 9ff1250dbd36
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: a465f59b0912
|
||||
---
|
||||
|
||||
# Create ZIP {#create-zip}
|
||||
|
||||
任意の種類の複数ファイルを 1 つの ZIP アーカイブにまとめます。重複するファイル名は自動的に重複が解消されます。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/create-zip`
|
||||
|
||||
2 つ以上のファイルを含む multipart フォームデータを受け付けます。settings フィールドは不要です。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールには設定可能なパラメータはありません。まとめる任意の種類のファイルを 2〜50 個アップロードします。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/create-zip \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@report.pdf" \
|
||||
-F "file=@data.csv" \
|
||||
-F "file=@photo.jpg"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive.zip",
|
||||
"originalSize": 3500000,
|
||||
"processedSize": 2800000
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 2〜50 個の入力ファイルが必要です。
|
||||
- 任意のファイル形式を受け付けます。入力形式に制限はありません。
|
||||
- 複数のファイルが同じ名前を共有する場合、数値のサフィックスを付けて自動的に重複が解消されます。
|
||||
- 出力アーカイブは標準の ZIP 圧縮（deflate）を使用します。
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
description: "CSV と Excel（XLSX）を双方向に変換します。"
|
||||
i18n_source_hash: 213297311e36
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 26b6e0a96d6d
|
||||
---
|
||||
|
||||
# CSV to Excel {#csv-to-excel}
|
||||
|
||||
CSV と Excel（XLSX）形式を双方向に変換します。CSV または TSV ファイルをアップロードすると XLSX が得られ、XLSX ファイルをアップロードすると CSV が得られます。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/csv-excel`
|
||||
|
||||
CSV、TSV、または XLSX ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| sheet | integer | No | `1` | XLSX から変換する際にエクスポートするワークシート番号（最小 1） |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
CSV から Excel:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/csv-excel \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@data.csv" \
|
||||
-F 'settings={"sheet": 1}'
|
||||
```
|
||||
|
||||
Excel から CSV:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/csv-excel \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@report.xlsx" \
|
||||
-F 'settings={"sheet": 2}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/data.xlsx",
|
||||
"originalSize": 2048,
|
||||
"processedSize": 5120
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 変換方向は入力ファイルの拡張子から自動検出されます。`.csv` または `.tsv` は `.xlsx` を生成し、`.xlsx` は `.csv` を生成します。
|
||||
- `sheet` パラメータは XLSX から変換する場合にのみ適用されます。どのワークシートをエクスポートするかを選択します。
|
||||
- TSV（タブ区切り値）ファイルは CSV とともにサポートされます。
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
description: "CSV と JSON を双方向に変換します。"
|
||||
i18n_source_hash: 978c08ad46d3
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: cf405d7e54d1
|
||||
---
|
||||
|
||||
# CSV to JSON {#csv-to-json}
|
||||
|
||||
CSV と JSON 形式を双方向に変換します。CSV または TSV ファイルをアップロードするとオブジェクトの JSON 配列が得られ、JSON 配列をアップロードすると CSV ファイルが得られます。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/csv-json`
|
||||
|
||||
CSV、TSV、または JSON ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| pretty | boolean | No | `true` | JSON 出力をインデント付きで整形して表示します |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
CSV から JSON:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/csv-json \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@users.csv" \
|
||||
-F 'settings={"pretty": true}'
|
||||
```
|
||||
|
||||
JSON から CSV:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/csv-json \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@users.json" \
|
||||
-F 'settings={}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/users.json",
|
||||
"originalSize": 1500,
|
||||
"processedSize": 2200
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 変換方向は入力ファイルの拡張子から自動検出されます。`.csv` または `.tsv` は `.json` を生成し、`.json` は `.csv` を生成します。
|
||||
- `pretty` パラメータは JSON 出力にのみ影響します。`false` に設定すると、出力はコンパクトな 1 行の JSON 文字列になります。
|
||||
- JSON 入力は、一貫したキーを持つオブジェクトの配列である必要があります。各オブジェクトが 1 行になり、各キーが列ヘッダーになります。
|
||||
- TSV（タブ区切り値）ファイルは CSV とともにサポートされます。
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "EPUB を PDF、DOCX、HTML、または Markdown に変換します。"
|
||||
i18n_source_hash: 7d94fc18ca97
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: daf3628358aa
|
||||
---
|
||||
|
||||
# Convert EPUB {#convert-epub}
|
||||
|
||||
EPUB 電子書籍を PDF、Word（DOCX）、HTML、または Markdown に変換します。書籍内のリモートリソースは取得されません。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/epub-convert`
|
||||
|
||||
EPUB ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Yes | - | 出力形式: `pdf`、`docx`、`html`、`md` |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/epub-convert \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@book.epub" \
|
||||
-F 'settings={"format": "pdf"}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。`/api/v1/jobs/{jobId}/progress` の SSE で進捗を追跡します。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.epub`。
|
||||
- EPUB に埋め込まれたリモートリソース（外部の画像、フォント）は、セキュリティのため取得されません。
|
||||
- 変換後の出力における画像の忠実度は、EPUB の構造によって異なる場合があります。
|
||||
- 変換はサーバー上の Pandoc によって処理されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "スプレッドシートを PDF に変換します。"
|
||||
i18n_source_hash: 4dbe2a810ea6
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 38b310ffa62a
|
||||
---
|
||||
|
||||
# Excel to PDF {#excel-to-pdf}
|
||||
|
||||
Excel、OpenDocument、または CSV のスプレッドシートを PDF に変換します。横に広いシートは複数ページにわたって分割されることがあります。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/excel-to-pdf`
|
||||
|
||||
Excel／ODS／CSV ファイルを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールには設定可能なパラメータはありません。スプレッドシートをアップロードすると PDF に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/excel-to-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@budget.xlsx"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。`/api/v1/jobs/{jobId}/progress` の SSE で進捗を追跡します。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.xlsx`、`.xls`、`.ods`、`.csv`。
|
||||
- 横に広いシートは、生成される PDF で複数ページに分割されることがあります。
|
||||
- グラフや条件付き書式は PDF 出力に描画されます。
|
||||
- 変換はサーバー上でヘッドレスで動作する LibreOffice によって処理されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "ボム保護付きで ZIP アーカイブから安全にファイルを展開します。"
|
||||
i18n_source_hash: 484a1f1051b8
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 04e2a826e325
|
||||
---
|
||||
|
||||
# Extract ZIP {#extract-zip}
|
||||
|
||||
ZIP アーカイブから安全にファイルを展開します。単一ファイルのアーカイブは含まれるファイルを直接返し、複数ファイルのアーカイブは展開された内容をフラットな ZIP で返します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/extract-zip`
|
||||
|
||||
ZIP ファイルを含む multipart フォームデータを受け付けます。settings フィールドは不要です。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールには設定可能なパラメータはありません。展開する `.zip` ファイルをアップロードします。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/extract-zip \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@archive.zip"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive_extracted.zip",
|
||||
"originalSize": 2800000,
|
||||
"processedSize": 3500000
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 入力として受け付けるのは `.zip` ファイルのみです。
|
||||
- アーカイブに単一のファイルが含まれる場合、そのファイルは直接返されます（ZIP でラップされません）。
|
||||
- アーカイブに複数のファイルが含まれる場合、すべてのファイルをルートレベルに展開したフラットな ZIP が返されます（ネストされたディレクトリ構造はフラット化されます）。
|
||||
- 組み込みのボム保護により、リソース枯渇を防ぐため、圧縮率やファイル数が過大なアーカイブは拒否されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "HTML ファイルを PDF に変換します。"
|
||||
i18n_source_hash: 20b9ae147db5
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 73feebb7571f
|
||||
---
|
||||
|
||||
# HTML to PDF {#html-to-pdf}
|
||||
|
||||
HTML ファイルをスタイル付きの PDF ドキュメントに変換します。リモートリソース（外部の画像、スタイルシート、スクリプト）はプライバシーのため無効化されています。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/html-to-pdf`
|
||||
|
||||
HTML ファイルを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールには設定可能なパラメータはありません。HTML ファイルをアップロードすると PDF に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/html-to-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@page.html"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。`/api/v1/jobs/{jobId}/progress` の SSE で進捗を追跡します。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.html`、`.htm`。
|
||||
- リモートリソース（URL で参照される画像、スタイルシート、スクリプト）は、プライバシーとセキュリティのため取得されません。
|
||||
- インラインスタイルと埋め込み画像（data URI）は保持されます。
|
||||
- 変換はサーバー上の WeasyPrint によって処理されます。
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
description: "JSON と XML を双方向に変換します。"
|
||||
i18n_source_hash: b3a6ded0c64a
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 356a33468b17
|
||||
---
|
||||
|
||||
# JSON to XML {#json-to-xml}
|
||||
|
||||
JSON と XML 形式を双方向に変換します。JSON ファイルをアップロードすると XML が得られ、XML ファイルをアップロードすると JSON が得られます。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/json-xml`
|
||||
|
||||
JSON または XML ファイルと JSON `settings` フィールドを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| pretty | boolean | No | `true` | 出力をインデント付きで整形して表示します |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
JSON から XML:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/json-xml \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@config.json" \
|
||||
-F 'settings={"pretty": true}'
|
||||
```
|
||||
|
||||
XML から JSON:
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/json-xml \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@config.xml" \
|
||||
-F 'settings={"pretty": true}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/config.xml",
|
||||
"originalSize": 850,
|
||||
"processedSize": 1200
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 変換方向は入力ファイルの拡張子から自動検出されます。`.json` は `.xml` を生成し、`.xml` は `.json` を生成します。
|
||||
- `pretty` パラメータは両方向に適用されます。`false` の場合、出力はインデントなしのコンパクトな形式になります。
|
||||
- XML の属性やネストされた構造は、可能な限り往復変換で保持されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Markdown ファイルを Word ドキュメント（DOCX）に変換します。"
|
||||
i18n_source_hash: 979cb8ee13f2
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: e2676e8a04df
|
||||
---
|
||||
|
||||
# Markdown to Word {#markdown-to-word}
|
||||
|
||||
Markdown ファイルを Word ドキュメント（DOCX）に変換し、見出し、リスト、コードブロック、その他の書式を保持します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/markdown-to-docx`
|
||||
|
||||
Markdown ファイルを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールには設定可能なパラメータはありません。Markdown ファイルをアップロードすると DOCX に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/markdown-to-docx \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@README.md"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/README.docx",
|
||||
"originalSize": 4500,
|
||||
"processedSize": 18200
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.md`、`.markdown`。
|
||||
- これは結果を直接返す高速（同期）ツールです。
|
||||
- 見出し、太字、斜体、リンク、コードブロック、リストは Word のスタイルにマッピングされます。
|
||||
- 変換はサーバー上の Pandoc によって処理されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Markdown ファイルをスタンドアロンの HTML ページに変換します。"
|
||||
i18n_source_hash: 3ef805e8fc8c
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 87daa2f75bab
|
||||
---
|
||||
|
||||
# Markdown to HTML {#markdown-to-html}
|
||||
|
||||
Markdown ファイルをスタンドアロンの HTML ページに変換します。ソースで参照されているリモート画像は、出力内でそのまま残されます。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/markdown-to-html`
|
||||
|
||||
Markdown ファイルを含む multipart フォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールには設定可能なパラメータはありません。Markdown ファイルをアップロードすると HTML に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/markdown-to-html \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@notes.md"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/notes.html",
|
||||
"originalSize": 3200,
|
||||
"processedSize": 5800
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.md`、`.markdown`。
|
||||
- これは結果を直接返す高速（同期）ツールです。
|
||||
- 出力はインラインスタイルを含む自己完結型の HTML ページです。
|
||||
- Markdown ソース内のリモート画像 URL はそのまま保持され、取得されません。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Markdown ファイルをスタイル付きの PDF に変換します。"
|
||||
i18n_source_hash: 18474dc8772a
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: e6d142ee6e12
|
||||
---
|
||||
|
||||
# Markdown to PDF {#markdown-to-pdf}
|
||||
|
||||
Markdown ファイルをスタイル付きの PDF ドキュメントに変換します。プライバシー保護のため、リモートリソースは無効化されています。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/markdown-to-pdf`
|
||||
|
||||
Markdown ファイルを含むマルチパートフォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。Markdown ファイルをアップロードすると PDF に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/markdown-to-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@document.md"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。進捗は `/api/v1/jobs/{jobId}/progress` の SSE で追跡できます。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.md`、`.markdown`。
|
||||
- プライバシーとセキュリティ保護のため、リモートリソース (URL 経由で参照される画像やスタイルシート) は取得されません。
|
||||
- Markdown はまず HTML にレンダリングされ、その後 WeasyPrint によって PDF に変換されます。
|
||||
- コードブロック、テーブル、その他の Markdown 要素は PDF 出力でスタイル付けされます。
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
description: "一致する列を持つ複数の CSV または TSV ファイルを 1 つに結合します。"
|
||||
i18n_source_hash: 109b5f399ac8
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: fdaf2335d43a
|
||||
---
|
||||
|
||||
# Merge CSVs {#merge-csvs}
|
||||
|
||||
一致する列を持つ複数の CSV または TSV ファイルを 1 つの結合ファイルにまとめます。すべての入力ファイルは同じ列ヘッダーを持っている必要があります。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/merge-csvs`
|
||||
|
||||
2 つ以上の CSV ファイルを含むマルチパートフォームデータを受け付けます。設定フィールドは不要です。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。一致する列ヘッダーを持つ 2 ～ 20 個の CSV または TSV ファイルをアップロードしてください。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/merge-csvs \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@january.csv" \
|
||||
-F "file=@february.csv" \
|
||||
-F "file=@march.csv"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/merged.csv",
|
||||
"originalSize": 30000,
|
||||
"processedSize": 28500
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 2 個以上 20 個以下の入力ファイルが必要です。
|
||||
- すべてのファイルは同じ列ヘッダーを共有している必要があります。列が一致しない場合、結合は失敗します。
|
||||
- ヘッダー行は出力に 1 回だけ含まれ、すべてのファイルのデータ行がアップロード順に連結されます。
|
||||
- CSV と TSV の両方のファイルを受け付けますが、1 回のリクエスト内のすべてのファイルは同じ区切り文字を使用する必要があります。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "プレゼンテーションを PDF に変換します。"
|
||||
i18n_source_hash: 49bd71c46bed
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: c57d81319497
|
||||
---
|
||||
|
||||
# PowerPoint to PDF {#powerpoint-to-pdf}
|
||||
|
||||
PowerPoint または OpenDocument のプレゼンテーションを、1 スライド 1 ページで PDF に変換します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/powerpoint-to-pdf`
|
||||
|
||||
PowerPoint/ODP ファイルを含むマルチパートフォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。プレゼンテーションをアップロードすると PDF に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/powerpoint-to-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@slides.pptx"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。進捗は `/api/v1/jobs/{jobId}/progress` の SSE で追跡できます。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.pptx`、`.ppt`、`.odp`。
|
||||
- 各スライドが PDF の 1 ページになります。
|
||||
- 変換はサーバー上でヘッドレス実行される LibreOffice によって処理されます。
|
||||
- アニメーションやトランジションは PDF 出力に含まれません。
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
description: "CSV を行数で分割して小さなファイルにします。"
|
||||
i18n_source_hash: a35dce4a99a3
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 097ab6d5414b
|
||||
---
|
||||
|
||||
# Split CSV {#split-csv}
|
||||
|
||||
大きな CSV または TSV ファイルを行数で小さなファイルに分割します。分割されたパートを含む ZIP アーカイブを返します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/split-csv`
|
||||
|
||||
CSV ファイルと JSON の `settings` フィールドを含むマルチパートフォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
| Parameter | Type | Required | Default | Description |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| rowsPerFile | integer | No | `1000` | 出力ファイルごとのデータ行数 (1 ～ 1,000,000) |
|
||||
| keepHeader | boolean | No | `true` | 各出力ファイルにヘッダー行を繰り返すかどうか |
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/split-csv \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@large-dataset.csv" \
|
||||
-F 'settings={"rowsPerFile": 500, "keepHeader": true}'
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/large-dataset_parts.zip",
|
||||
"originalSize": 1048576,
|
||||
"processedSize": 1050000
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 出力は常に、分割された CSV パートを含む ZIP アーカイブで、連番で命名されます (例: `part-1.csv`、`part-2.csv`)。
|
||||
- `keepHeader` が `true` の場合、各パートに元のヘッダー行が含まれるため、各ファイルを個別に使用できます。
|
||||
- 入力として CSV と TSV の両方のファイルを受け付けます。
|
||||
- 行数はデータ行のみを指します。ヘッダー行はカウントされません。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Word、Markdown、HTML、またはプレーンテキストファイルを EPUB に変換します。"
|
||||
i18n_source_hash: 63e1afa91c52
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: aa0fde2c528f
|
||||
---
|
||||
|
||||
# Convert to EPUB {#convert-to-epub}
|
||||
|
||||
Word ドキュメント、Markdown、HTML、またはプレーンテキストファイルを EPUB 電子書籍形式に変換します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/to-epub`
|
||||
|
||||
Word/Markdown/HTML/TXT ファイルを含むマルチパートフォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。ドキュメントをアップロードすると EPUB に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/to-epub \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@manuscript.docx"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。進捗は `/api/v1/jobs/{jobId}/progress` の SSE で追跡できます。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.docx`、`.md`、`.html`、`.txt`。
|
||||
- EPUB 出力は EPUB 3 仕様に準拠します。
|
||||
- ソースドキュメント内の見出しが目次の生成に使用されます。
|
||||
- 変換はサーバー上の Pandoc によって処理されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Word ドキュメントを PDF に変換します。"
|
||||
i18n_source_hash: f814ba1a1a53
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: fa2981cd461d
|
||||
---
|
||||
|
||||
# Word to PDF {#word-to-pdf}
|
||||
|
||||
Word ドキュメント、OpenDocument テキスト、RTF、またはプレーンテキストファイルを PDF に変換します。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/word-to-pdf`
|
||||
|
||||
Word/ODT/RTF/TXT ファイルを含むマルチパートフォームデータを受け付けます。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。ドキュメントをアップロードすると PDF に変換されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/word-to-pdf \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@report.docx"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
`202 Accepted` を返します。進捗は `/api/v1/jobs/{jobId}/progress` の SSE で追跡できます。
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 受け付ける入力形式: `.docx`、`.doc`、`.odt`、`.rtf`、`.txt`。
|
||||
- 変換はサーバー上でヘッドレス実行される LibreOffice によって処理されます。
|
||||
- 利用可能な場合はドキュメントに埋め込まれたフォントが使用され、そうでない場合はシステムフォントに置き換えられます。
|
||||
- ヘッダー、フッター、テーブル、画像は PDF 出力で保持されます。
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "XML から繰り返し要素を抽出して CSV テーブルにします。"
|
||||
i18n_source_hash: 3ab1019bff8a
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: a0112376720f
|
||||
---
|
||||
|
||||
# XML to CSV {#xml-to-csv}
|
||||
|
||||
XML ファイルから繰り返し要素を抽出してフラットな CSV テーブルにします。このツールは XML ツリー内で最初のオブジェクト配列を自動的に見つけ、各要素を 1 行にマッピングします。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/xml-to-csv`
|
||||
|
||||
XML ファイルを含むマルチパートフォームデータを受け付けます。設定フィールドは不要です。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。繰り返し要素は XML 構造から自動検出されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:1349/api/v1/tools/files/xml-to-csv \
|
||||
-H "Authorization: Bearer si_your-api-key" \
|
||||
-F "file=@catalog.xml"
|
||||
```
|
||||
|
||||
## Example Response {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/catalog.csv",
|
||||
"originalSize": 4500,
|
||||
"processedSize": 1800
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 入力として `.xml` ファイルのみを受け付けます。
|
||||
- このツールは XML ツリーをスキャンして、最初に繰り返される兄弟要素のセットを見つけ、それらを行として使用します。
|
||||
- 一意の各子要素名または属性名が CSV の列ヘッダーになります。
|
||||
- これは一方向の変換です。双方向の JSON/XML 変換には [JSON to XML](/ja/tools/files/json-xml) ツールを使用してください。
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
description: "YAML と JSON を双方向で変換します。"
|
||||
i18n_source_hash: acf8ca21ee99
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: e39453464e79
|
||||
---
|
||||
|
||||
# YAML / JSON {#yaml-json}
|
||||
|
||||
YAML と JSON 形式を双方向で変換します。YAML ファイルをアップロードすると JSON が得られ、JSON ファイルをアップロードすると YAML が得られます。
|
||||
|
||||
## API Endpoint {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/yaml-json`
|
||||
|
||||
YAML または JSON ファイルを含むマルチパートフォームデータを受け付けます。設定フィールドは不要です。
|
||||
|
||||
## Parameters {#parameters}
|
||||
|
||||
このツールに設定可能なパラメータはありません。変換方向は入力ファイルの拡張子によって決定されます。
|
||||
|
||||
## Example Request {#example-request}
|
||||
|
||||
YAML から JSON へ:
|
||||
|
||||
```bash
|
||||
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 へ:
|
||||
|
||||
```bash
|
||||
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 {#example-response}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/config.json",
|
||||
"originalSize": 620,
|
||||
"processedSize": 780
|
||||
}
|
||||
```
|
||||
|
||||
## Notes {#notes}
|
||||
|
||||
- 変換方向は入力ファイルの拡張子から自動検出されます。`.yaml` または `.yml` は `.json` を生成し、`.json` は `.yaml` を生成します。
|
||||
- `.yaml` と `.yml` の両方の拡張子を受け付けます。
|
||||
- 複数ドキュメントの YAML ファイルでは最初のドキュメントのみが変換されます。`---` で区切られた追加のドキュメントは無視されます。
|
||||
Reference in New Issue
Block a user