Esegui nella sandbox

API JSON in YAML#

Converti un file JSON in YAML con una singola richiesta a POST /v1/convert/json-to-yaml. La conversione è una mappatura diretta senza ristrutturazione: l'output è YAML in stile block leggibile, con l'ordine originale delle chiavi e i caratteri unicode preservati. Per default la risposta è costituita dai byte YAML grezzi; imposta direct_download=false per ricevere invece metadati con un URL di download presigned.

Endpoint#

POST /v1/convert/json-to-yaml

Content-Type: multipart/form-data

Input accettato: file .json (codificati in UTF-8)

Formato di output: .yaml (application/x-yaml)

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 `.json` da convertire. Deve essere codificato in UTF-8.
`output_filename`	`string`	No	Nome del file di input	Nome file di output personalizzato. L'estensione `.yaml` viene aggiunta automaticamente.
`direct_download`	`boolean`	No	`true`	Con `true`, restituisce i byte YAML grezzi. Con `false`, restituisce metadati con un URL di download presigned.

Regole di conversione#

Mappatura diretta da JSON a YAML senza ristrutturazione:

{
  "database": {
    "host": "localhost",
    "port": 5432,
    "credentials": {
      "user": "admin",
      "password": "secret"
    }
  },
  "features": ["auth", "logging"]
}

Diventa:

database:
  host: localhost
  port: 5432
  credentials:
    user: admin
    password: secret
features:
- auth
- logging

L'output usa lo stile block (multi-riga, leggibile), non lo stile flow
L'ordine delle chiavi è preservato dal JSON originale
I caratteri unicode sono preservati così come sono

Risposta#

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

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

Risposta con metadati (`direct_download=false`)#

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

Esempi di codice#

Python#

import requests

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

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

Node.js#

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

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

const yaml = await response.text();

PHP#

$ch = curl_init("https://api.enconvert.com/v1/convert/json-to-yaml");
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.json", "application/json")]
]);
$yaml = curl_exec($ch);
curl_close($ch);

Go#

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

req, _ := http.NewRequest("POST", "https://api.enconvert.com/v1/convert/json-to-yaml", 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 `.json`
`400 Bad Request`	Contenuto JSON non valido
`400 Bad Request`	Conversione da JSON a YAML 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
Conversioni mensili	Dipende dal piano

Domande frequenti#

Come converto JSON in YAML con una API REST?#

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

La conversione da JSON a YAML preserva l'ordine delle chiavi?#

Sì. L'ordine delle chiavi del JSON originale è preservato, i caratteri unicode restano invariati e la struttura viene mappata direttamente senza ristrutturazione.

L'output YAML è in stile block o flow?#

L'output usa lo stile block (YAML multi-riga e leggibile), non lo stile flow inline, come mostrato nell'esempio di conversione in questa pagina.

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

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

Perché l'API JSON in YAML restituisce 400 Bad Request?#

Un 400 viene restituito quando il file non è un file .json, il contenuto non è JSON valido o la conversione fallisce. I file oltre il limite di dimensione del tuo piano restituiscono 413 Payload Too Large.

← xml-to-json yaml-to-json →

API Documentation