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: d4bf64976710
|
||||
---
|
||||
|
||||
# Конструктор диаграмм {#chart-maker}
|
||||
|
||||
Создание столбчатых, линейных или круговых диаграмм из данных CSV или JSON. Возвращает изображение PNG с отрисованной диаграммой.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/chart-maker`
|
||||
|
||||
Принимает multipart form data с файлом CSV или JSON и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| kind | string | Нет | `"bar"` | Тип диаграммы: `bar`, `line`, `pie` |
|
||||
| title | string | Нет | - | Заголовок диаграммы (максимум 120 символов) |
|
||||
| width | integer | Нет | `960` | Ширина диаграммы в пикселях (320-2048) |
|
||||
| height | integer | Нет | `540` | Высота диаграммы в пикселях (240-1536) |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/sales_chart.png",
|
||||
"originalSize": 1024,
|
||||
"processedSize": 48500
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Входные данные должны быть файлом `.csv` или `.json`. Файлы CSV должны содержать строку заголовка с именами столбцов.
|
||||
- Первый столбец используется как метка категории; второй столбец должен быть числовым и предоставляет значения данных. Используются только два столбца.
|
||||
- Входные данные JSON должны быть массивом объектов `{label, value}` или простым объектом, ключи которого становятся метками, а значения точками данных.
|
||||
- Максимум 100 точек данных. Все значения должны быть нулевыми или больше.
|
||||
- Выходной файл всегда является изображением PNG независимо от входного формата.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "Конвертация между форматами Word, OpenDocument, RTF и обычного текста."
|
||||
i18n_source_hash: 89771292569d
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: c70e1cad6e24
|
||||
---
|
||||
|
||||
# Конвертация документа {#convert-document}
|
||||
|
||||
Конвертация документов между форматами Word (DOCX), OpenDocument (ODT), RTF и обычного текста с помощью LibreOffice.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/convert-document`
|
||||
|
||||
Принимает multipart form data с файлом Word/ODT/RTF/TXT и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Да | - | Формат вывода: `docx`, `odt`, `rtf`, `txt` |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.docx`, `.doc`, `.odt`, `.rtf`, `.txt`.
|
||||
- Конвертация выполняется LibreOffice, работающим в безголовом режиме на сервере.
|
||||
- Сложное форматирование (макросы, встроенные объекты) может не сохраниться при конвертации между форматами.
|
||||
- Выходной формат должен отличаться от входного.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "Конвертация между форматами презентаций PowerPoint и OpenDocument."
|
||||
i18n_source_hash: 08ba415d39ac
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 05816e87e646
|
||||
---
|
||||
|
||||
# Конвертация презентации {#convert-presentation}
|
||||
|
||||
Конвертация презентаций между форматами PowerPoint (PPTX) и OpenDocument Presentation (ODP).
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/convert-presentation`
|
||||
|
||||
Принимает multipart form data с файлом PowerPoint/ODP и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Да | - | Формат вывода: `pptx`, `odp` |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.pptx`, `.ppt`, `.odp`.
|
||||
- Конвертация выполняется LibreOffice, работающим в безголовом режиме на сервере.
|
||||
- Анимации и эффекты переходов могут не сохраниться между форматами.
|
||||
- Выходной формат должен отличаться от входного.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "Конвертация между форматами Excel, OpenDocument и CSV."
|
||||
i18n_source_hash: b813b1b06962
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: f78d09466949
|
||||
---
|
||||
|
||||
# Конвертация таблицы {#convert-spreadsheet}
|
||||
|
||||
Конвертация таблиц между форматами Excel (XLSX), OpenDocument Spreadsheet (ODS) и CSV. Из книг с несколькими листами при конвертации в CSV экспортируется первый лист.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/convert-spreadsheet`
|
||||
|
||||
Принимает multipart form data с файлом Excel/ODS/CSV и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Да | - | Формат вывода: `xlsx`, `ods`, `csv` |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.xlsx`, `.xls`, `.ods`, `.csv`.
|
||||
- При конвертации книги с несколькими листами в CSV экспортируется только первый лист.
|
||||
- Формулы вычисляются и экспортируются как статические значения в выводе CSV.
|
||||
- Выходной формат должен отличаться от входного.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
description: "Объединение нескольких файлов в один ZIP-архив."
|
||||
i18n_source_hash: 9ff1250dbd36
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: a94db426c454
|
||||
---
|
||||
|
||||
# Создание ZIP {#create-zip}
|
||||
|
||||
Объединение нескольких файлов любого типа в один ZIP-архив. Повторяющиеся имена файлов автоматически устраняются.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/create-zip`
|
||||
|
||||
Принимает multipart form data с двумя или более файлами. Поле настроек не требуется.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите от 2 до 50 файлов любого типа для объединения.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive.zip",
|
||||
"originalSize": 3500000,
|
||||
"processedSize": 2800000
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Требуется от 2 до 50 входных файлов.
|
||||
- Принимается любой тип файла; ограничений на входной формат нет.
|
||||
- Если несколько файлов имеют одинаковое имя, они автоматически различаются числовыми суффиксами.
|
||||
- Выходной архив использует стандартное сжатие ZIP (deflate).
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
description: "Конвертация между CSV и Excel (XLSX) в обоих направлениях."
|
||||
i18n_source_hash: 213297311e36
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: c7ca7450f501
|
||||
---
|
||||
|
||||
# CSV в Excel {#csv-to-excel}
|
||||
|
||||
Конвертация между форматами CSV и Excel (XLSX) в обоих направлениях. Загрузите файл CSV или TSV, чтобы получить XLSX, или загрузите файл XLSX, чтобы получить CSV.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/csv-excel`
|
||||
|
||||
Принимает multipart form data с файлом CSV, TSV или XLSX и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| sheet | integer | Нет | `1` | Номер листа для экспорта при конвертации из XLSX (минимум 1) |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/data.xlsx",
|
||||
"originalSize": 2048,
|
||||
"processedSize": 5120
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#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: f6973b0d850a
|
||||
---
|
||||
|
||||
# CSV в JSON {#csv-to-json}
|
||||
|
||||
Конвертация между форматами CSV и JSON в обоих направлениях. Загрузите файл CSV или TSV, чтобы получить массив объектов JSON, или загрузите массив JSON, чтобы получить файл CSV.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/csv-json`
|
||||
|
||||
Принимает multipart form data с файлом CSV, TSV или JSON и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| pretty | boolean | Нет | `true` | Форматированный вывод JSON с отступами |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/users.json",
|
||||
"originalSize": 1500,
|
||||
"processedSize": 2200
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Направление конвертации автоматически определяется по расширению входного файла: `.csv` или `.tsv` производит `.json`, а `.json` производит `.csv`.
|
||||
- Параметр `pretty` влияет только на вывод JSON. При значении `false` выводом является компактная однострочная строка JSON.
|
||||
- Входные данные JSON должны быть массивом объектов с согласованными ключами. Каждый объект становится строкой, а каждый ключ становится заголовком столбца.
|
||||
- Файлы TSV (значения, разделённые табуляцией) поддерживаются наряду с CSV.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
description: "Конвертация EPUB в PDF, DOCX, HTML или Markdown."
|
||||
i18n_source_hash: 7d94fc18ca97
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: e6fc76653944
|
||||
---
|
||||
|
||||
# Конвертация EPUB {#convert-epub}
|
||||
|
||||
Конвертация электронной книги EPUB в PDF, Word (DOCX), HTML или Markdown. Удалённые ресурсы внутри книги не загружаются.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/epub-convert`
|
||||
|
||||
Принимает multipart form data с файлом EPUB и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| format | string | Да | - | Формат вывода: `pdf`, `docx`, `html`, `md` |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемый входной формат: `.epub`.
|
||||
- Удалённые ресурсы, встроенные в EPUB (внешние изображения, шрифты), не загружаются в целях безопасности.
|
||||
- Точность изображений в конвертированном выводе может различаться в зависимости от структуры EPUB.
|
||||
- Конвертация выполняется Pandoc на сервере.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Конвертация таблиц в PDF."
|
||||
i18n_source_hash: 4dbe2a810ea6
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: b23deeffc71d
|
||||
---
|
||||
|
||||
# Excel в PDF {#excel-to-pdf}
|
||||
|
||||
Конвертация таблиц Excel, OpenDocument или CSV в PDF. Широкие листы могут разбиваться на несколько страниц.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/excel-to-pdf`
|
||||
|
||||
Принимает multipart form data с файлом Excel/ODS/CSV.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите таблицу, и она будет конвертирована в PDF.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.xlsx`, `.xls`, `.ods`, `.csv`.
|
||||
- Широкие листы могут быть разбиты на несколько страниц в итоговом PDF.
|
||||
- Диаграммы и условное форматирование отрисовываются в выводе PDF.
|
||||
- Конвертация выполняется LibreOffice, работающим в безголовом режиме на сервере.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Безопасное извлечение файлов из ZIP-архива с защитой от бомб."
|
||||
i18n_source_hash: 484a1f1051b8
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 55ed372ae1a3
|
||||
---
|
||||
|
||||
# Извлечение ZIP {#extract-zip}
|
||||
|
||||
Безопасное извлечение файлов из ZIP-архива. Архивы с одним файлом возвращают содержащийся файл напрямую; архивы с несколькими файлами возвращают плоский ZIP с извлечённым содержимым.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/extract-zip`
|
||||
|
||||
Принимает multipart form data с файлом ZIP. Поле настроек не требуется.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите файл `.zip` для извлечения.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/archive_extracted.zip",
|
||||
"originalSize": 2800000,
|
||||
"processedSize": 3500000
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- В качестве входных данных принимаются только файлы `.zip`.
|
||||
- Если архив содержит один файл, этот файл возвращается напрямую (не упакованным в ZIP).
|
||||
- Если архив содержит несколько файлов, возвращается плоский ZIP со всеми файлами, извлечёнными на корневой уровень (вложенная структура каталогов уплощается).
|
||||
- Встроенная защита от бомб отклоняет архивы с чрезмерными коэффициентами сжатия или количеством файлов, чтобы предотвратить исчерпание ресурсов.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Конвертация файла HTML в PDF."
|
||||
i18n_source_hash: 20b9ae147db5
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: e08607c41b3f
|
||||
---
|
||||
|
||||
# HTML в PDF {#html-to-pdf}
|
||||
|
||||
Конвертация файла HTML в стилизованный документ PDF. Удалённые ресурсы (внешние изображения, таблицы стилей, скрипты) отключены в целях конфиденциальности.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/html-to-pdf`
|
||||
|
||||
Принимает multipart form data с файлом HTML.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите файл HTML, и он будет конвертирован в PDF.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.html`, `.htm`.
|
||||
- Удалённые ресурсы (изображения, таблицы стилей, скрипты, на которые ссылаются URL) не загружаются в целях конфиденциальности и безопасности.
|
||||
- Встроенные стили и встроенные изображения (data URI) сохраняются.
|
||||
- Конвертация выполняется WeasyPrint на сервере.
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
description: "Конвертация между JSON и XML в обоих направлениях."
|
||||
i18n_source_hash: b3a6ded0c64a
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 85196f2a621c
|
||||
---
|
||||
|
||||
# JSON в XML {#json-to-xml}
|
||||
|
||||
Конвертация между форматами JSON и XML в обоих направлениях. Загрузите файл JSON, чтобы получить XML, или загрузите файл XML, чтобы получить JSON.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/json-xml`
|
||||
|
||||
Принимает multipart form data с файлом JSON или XML и JSON-полем `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| pretty | boolean | Нет | `true` | Форматированный вывод с отступами |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/config.xml",
|
||||
"originalSize": 850,
|
||||
"processedSize": 1200
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#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: c66ccfdbebf7
|
||||
---
|
||||
|
||||
# Markdown в Word {#markdown-to-word}
|
||||
|
||||
Конвертация файла Markdown в документ Word (DOCX) с сохранением заголовков, списков, блоков кода и другого форматирования.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/markdown-to-docx`
|
||||
|
||||
Принимает multipart form data с файлом Markdown.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите файл Markdown, и он будет конвертирован в DOCX.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/README.docx",
|
||||
"originalSize": 4500,
|
||||
"processedSize": 18200
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.md`, `.markdown`.
|
||||
- Это быстрый (синхронный) инструмент, который возвращает результат напрямую.
|
||||
- Заголовки, полужирный, курсив, ссылки, блоки кода и списки сопоставляются со стилями Word.
|
||||
- Конвертация выполняется Pandoc на сервере.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Конвертация файла Markdown в автономную HTML-страницу."
|
||||
i18n_source_hash: 3ef805e8fc8c
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 6df2fee7eb7a
|
||||
---
|
||||
|
||||
# Markdown в HTML {#markdown-to-html}
|
||||
|
||||
Конвертация файла Markdown в автономную HTML-страницу. Удалённые изображения, на которые есть ссылки в исходнике, остаются в выводе без изменений.
|
||||
|
||||
## Эндпоинт API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/markdown-to-html`
|
||||
|
||||
Принимает multipart form data с файлом Markdown.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите файл Markdown, и он будет конвертирован в HTML.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/notes.html",
|
||||
"originalSize": 3200,
|
||||
"processedSize": 5800
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые входные форматы: `.md`, `.markdown`.
|
||||
- Это быстрый (синхронный) инструмент, который возвращает результат напрямую.
|
||||
- Вывод представляет собой самодостаточную HTML-страницу со встроенными стилями.
|
||||
- URL удалённых изображений в исходнике Markdown сохраняются без изменений и не загружаются.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Преобразование файла Markdown в стилизованный PDF."
|
||||
i18n_source_hash: 18474dc8772a
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: d3e35c50399c
|
||||
---
|
||||
|
||||
# Markdown в PDF {#markdown-to-pdf}
|
||||
|
||||
Преобразуйте файл Markdown в стилизованный документ PDF. Удалённые ресурсы отключены в целях конфиденциальности.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/markdown-to-pdf`
|
||||
|
||||
Принимает multipart form data с файлом Markdown.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите файл Markdown, и он будет преобразован в PDF.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые форматы ввода: `.md`, `.markdown`.
|
||||
- Удалённые ресурсы (изображения, таблицы стилей, на которые ссылаются URL) не загружаются в целях конфиденциальности и безопасности.
|
||||
- Markdown сначала преобразуется в HTML, затем в PDF с помощью WeasyPrint.
|
||||
- Блоки кода, таблицы и другие элементы Markdown стилизуются в выходном PDF.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
description: "Объединение нескольких файлов CSV или TSV с совпадающими столбцами в один."
|
||||
i18n_source_hash: 109b5f399ac8
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 1e7be7503f4d
|
||||
---
|
||||
|
||||
# Объединение CSV {#merge-csvs}
|
||||
|
||||
Объедините несколько файлов CSV или TSV с совпадающими столбцами в один общий файл. Все входные файлы должны иметь одинаковые заголовки столбцов.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/merge-csvs`
|
||||
|
||||
Принимает multipart form data с двумя или более файлами CSV. Поле настроек не требуется.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите от 2 до 20 файлов CSV или TSV с совпадающими заголовками столбцов.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/merged.csv",
|
||||
"originalSize": 30000,
|
||||
"processedSize": 28500
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Требуется от 2 до 20 входных файлов.
|
||||
- Все файлы должны иметь одинаковые заголовки столбцов. Объединение завершится ошибкой, если столбцы не совпадают.
|
||||
- Строка заголовка включается в вывод один раз; строки данных из всех файлов объединяются в порядке загрузки.
|
||||
- Принимаются как файлы CSV, так и TSV, но все файлы в одном запросе должны использовать один и тот же разделитель.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Преобразование презентаций в PDF."
|
||||
i18n_source_hash: 49bd71c46bed
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 415bb45ea070
|
||||
---
|
||||
|
||||
# PowerPoint в PDF {#powerpoint-to-pdf}
|
||||
|
||||
Преобразуйте презентации PowerPoint или OpenDocument в PDF, по одному слайду на страницу.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/powerpoint-to-pdf`
|
||||
|
||||
Принимает multipart form data с файлом PowerPoint/ODP.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите презентацию, и она будет преобразована в PDF.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые форматы ввода: `.pptx`, `.ppt`, `.odp`.
|
||||
- Каждый слайд становится одной страницей в PDF.
|
||||
- Преобразование выполняется LibreOffice, работающим в headless-режиме на сервере.
|
||||
- Анимации и переходы не включаются в выходной PDF.
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
description: "Разделение CSV на файлы меньшего размера по количеству строк."
|
||||
i18n_source_hash: a35dce4a99a3
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: bf4258d7aa38
|
||||
---
|
||||
|
||||
# Разделение CSV {#split-csv}
|
||||
|
||||
Разделите большой файл CSV или TSV на файлы меньшего размера по количеству строк. Возвращает ZIP-архив с частями.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/split-csv`
|
||||
|
||||
Принимает multipart form data с файлом CSV и полем JSON `settings`.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
| Параметр | Тип | Обязательный | По умолчанию | Описание |
|
||||
|-----------|------|----------|---------|-------------|
|
||||
| rowsPerFile | integer | Нет | `1000` | Количество строк данных на выходной файл (1–1 000 000) |
|
||||
| keepHeader | boolean | Нет | `true` | Повторять строку заголовка в каждом выходном файле |
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```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}
|
||||
|
||||
- Вывод всегда представляет собой ZIP-архив с разделёнными частями CSV, названными последовательно (например, `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: 77fe8b2fcde1
|
||||
---
|
||||
|
||||
# Преобразование в EPUB {#convert-to-epub}
|
||||
|
||||
Преобразуйте документы Word, Markdown, HTML или файлы обычного текста в формат электронной книги EPUB.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/to-epub`
|
||||
|
||||
Принимает multipart form data с файлом Word/Markdown/HTML/TXT.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите документ, и он будет преобразован в EPUB.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#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: da95a50a168f
|
||||
---
|
||||
|
||||
# Word в PDF {#word-to-pdf}
|
||||
|
||||
Преобразуйте документы Word, текст OpenDocument, RTF или файлы обычного текста в PDF.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/word-to-pdf`
|
||||
|
||||
Принимает multipart form data с файлом Word/ODT/RTF/TXT.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Загрузите документ, и он будет преобразован в PDF.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
Возвращает `202 Accepted`. Отслеживайте прогресс через SSE по адресу `/api/v1/jobs/{jobId}/progress`.
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"async": true
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- Принимаемые форматы ввода: `.docx`, `.doc`, `.odt`, `.rtf`, `.txt`.
|
||||
- Преобразование выполняется LibreOffice, работающим в headless-режиме на сервере.
|
||||
- При наличии используются шрифты, встроенные в документ; в противном случае подставляются системные шрифты.
|
||||
- Верхние и нижние колонтитулы, таблицы и изображения сохраняются в выходном PDF.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
description: "Извлечение повторяющихся элементов из XML в таблицу CSV."
|
||||
i18n_source_hash: 3ab1019bff8a
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: b9c246538577
|
||||
---
|
||||
|
||||
# XML в CSV {#xml-to-csv}
|
||||
|
||||
Извлеките повторяющиеся элементы из файла XML в плоскую таблицу CSV. Инструмент автоматически находит первый массив объектов в дереве XML и сопоставляет каждый элемент со строкой.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/xml-to-csv`
|
||||
|
||||
Принимает multipart form data с файлом XML. Поле настроек не требуется.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Повторяющийся элемент автоматически определяется по структуре XML.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
||||
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/catalog.csv",
|
||||
"originalSize": 4500,
|
||||
"processedSize": 1800
|
||||
}
|
||||
```
|
||||
|
||||
## Примечания {#notes}
|
||||
|
||||
- В качестве ввода принимаются только файлы `.xml`.
|
||||
- Инструмент сканирует дерево XML в поисках первого повторяющегося набора соседних элементов и использует их в качестве строк.
|
||||
- Каждое уникальное имя дочернего элемента или атрибута становится заголовком столбца CSV.
|
||||
- Это одностороннее преобразование. Для двустороннего преобразования JSON/XML используйте инструмент [JSON в XML](/ru/tools/files/json-xml).
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
description: "Преобразование между YAML и JSON в обоих направлениях."
|
||||
i18n_source_hash: acf8ca21ee99
|
||||
i18n_provenance: human
|
||||
i18n_output_hash: 2634cecb09dc
|
||||
---
|
||||
|
||||
# YAML / JSON {#yaml-json}
|
||||
|
||||
Преобразуйте форматы YAML и JSON в обоих направлениях. Загрузите файл YAML, чтобы получить JSON, или загрузите файл JSON, чтобы получить YAML.
|
||||
|
||||
## Конечная точка API {#api-endpoint}
|
||||
|
||||
`POST /api/v1/tools/files/yaml-json`
|
||||
|
||||
Принимает multipart form data с файлом YAML или JSON. Поле настроек не требуется.
|
||||
|
||||
## Параметры {#parameters}
|
||||
|
||||
У этого инструмента нет настраиваемых параметров. Направление преобразования определяется по расширению входного файла.
|
||||
|
||||
## Пример запроса {#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}
|
||||
|
||||
```json
|
||||
{
|
||||
"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; дополнительные документы, разделённые `---`, игнорируются.
|
||||
Reference in New Issue
Block a user