Esegui nella sandbox

API YAML in JSON#

Converti un file YAML in JSON con una singola richiesta a POST /v1/convert/yaml-to-json. Accetta input .yaml o .yml, usa il parsing sicuro (nessuna esecuzione di codice arbitrario) e produce JSON formattato con indentazione a 2 spazi. Le risposte restituiscono byte JSON grezzi per default, oppure metadati con un URL di download presigned quando direct_download=false.

Endpoint#

POST /v1/convert/yaml-to-json

Content-Type: multipart/form-data

Input accettato: file .yaml o .yml (codificati in UTF-8)

Formato di output: .json (application/json)

Autenticazione#

Richiede una chiave API privata oppure un token JWT ottenuto da una chiave pubblica.

X-API-Key: sk_your_private_key

Oppure:

Authorization: Bearer <jwt_token>

Parametri della richiesta#

Parametro	Tipo	Obbligatorio	Default	Descrizione
`file`	file	Sì	--	Il file `.yaml` o `.yml` da convertire. Deve essere codificato in UTF-8.
`output_filename`	`string`	No	Nome del file di input	Nome file di output personalizzato. L'estensione `.json` viene aggiunta automaticamente.
`direct_download`	`boolean`	No	`true`	Con `true`, restituisce i byte JSON grezzi. Con `false`, restituisce metadati con un URL di download presigned.

Regole di conversione#

Mappatura diretta da YAML a JSON:

database:
  host: localhost
  port: 5432
features:
- auth
- logging
enabled: true

Diventa:

{
  "database": {
    "host": "localhost",
    "port": 5432
  },
  "features": ["auth", "logging"],
  "enabled": true
}

Usa il parsing sicuro -- nessuna costruzione arbitraria di oggetti Python dai tag YAML
I tipi YAML sono mappati in modo naturale: stringhe, numeri, booleani, null, array, oggetti
L'output ha indentazione a 2 spazi con unicode preservato

Nota: Viene convertito solo il primo documento YAML. Nei file YAML multi-documento separati da --- verrà elaborato solo il primo documento.

Risposta#

Download diretto (`direct_download=true`, default)#

HTTP 200 OK
Content-Type: application/json
Content-Disposition: inline; filename="config_20260405_123456789.json"

Risposta con metadati (`direct_download=false`)#

{
    "presigned_url": "https://spaces.example.com/...",
    "object_key": "env/files/{project_id}/yaml-to-json/config_20260405_123456789.json",
    "filename": "config_20260405_123456789.json",
    "file_size": 1234,
    "conversion_time_seconds": 0.03
}

Esempi di codice#

Python#

import requests

with open("config.yaml", "rb") as f:
    response = requests.post(
        "https://api.enconvert.com/v1/convert/yaml-to-json",
        headers={"X-API-Key": "sk_your_private_key"},
        files={"file": ("config.yaml", f, "application/x-yaml")}
    )

with open("config.json", "wb") as out:
    out.write(response.content)

Node.js#

const form = new FormData();
form.append("file", fs.createReadStream("config.yaml"));

const response = await fetch("https://api.enconvert.com/v1/convert/yaml-to-json", {
    method: "POST",
    headers: { "X-API-Key": "sk_your_private_key" },
    body: form
});

const json = await response.json();

PHP#

$ch = curl_init("https://api.enconvert.com/v1/convert/yaml-to-json");
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-Key: sk_your_private_key"],
    CURLOPT_POSTFIELDS => ["file" => new CURLFile("config.yaml")]
]);
$json = curl_exec($ch);
curl_close($ch);

Go#

body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormFile("file", "config.yaml")
file, _ := os.Open("config.yaml")
io.Copy(part, file)
writer.Close()

req, _ := http.NewRequest("POST", "https://api.enconvert.com/v1/convert/yaml-to-json", body)
req.Header.Set("Content-Type", writer.FormDataContentType())
req.Header.Set("X-API-Key", "sk_your_private_key")
resp, _ := http.DefaultClient.Do(req)

Risposte di errore#

Stato	Condizione
`400 Bad Request`	Il file non è un file `.yaml` o `.yml`
`400 Bad Request`	Contenuto YAML non valido
`400 Bad Request`	Conversione da YAML a JSON non riuscita
`401 Unauthorized`	Chiave API / token JWT mancante o non valido
`402 Payment Required`	Quota mensile di ops esaurita
`413 Payload Too Large`	Il file supera la dimensione massima del piano

Limiti#

Limite	Valore
Dimensione massima del file	Dipende dal piano (Founding: 5 MB)
Codifica di input	Solo UTF-8
Documenti YAML	Solo il primo documento
Conversioni mensili	Dipende dal piano

Domande frequenti#

Come converto YAML in JSON con una API REST?#

Invia una richiesta POST multipart/form-data a /v1/convert/yaml-to-json con il file .yaml o .yml nel campo file, autenticandoti con un header X-API-Key o un token JWT Authorization: Bearer. La risposta è JSON formattato con indentazione a 2 spazi.

È sicuro convertire in JSON file YAML non attendibili?#

L'endpoint usa il parsing sicuro: nessuna costruzione arbitraria di oggetti Python dai tag YAML e nessuna esecuzione di codice arbitrario. I tipi YAML vengono mappati in modo naturale su stringhe, numeri, booleani, null, array e oggetti JSON.

Posso convertire in JSON file YAML multi-documento?#

Viene convertito solo il primo documento YAML. Nei file con più documenti separati da ---, tutto ciò che segue il primo documento non viene elaborato.

I file .yml sono accettati come i .yaml?#

Sì. Sono accettate entrambe le estensioni .yaml e .yml; qualsiasi altra estensione restituisce 400 Bad Request. I file devono essere codificati in UTF-8.

Posso ottenere un URL di download presigned invece dei byte JSON grezzi?#

Sì. Imposta direct_download=false per ricevere metadati con presigned_url, object_key, filename, file_size e conversion_time_seconds.

← json-to-yaml json-to-csv →

API Documentation