API de YAML a JSON#

Convierte un archivo YAML a JSON con una sola petición a POST /v1/convert/yaml-to-json. Acepta entrada .yaml o .yml, usa parseo seguro (sin ejecución de código arbitrario) y produce JSON con formato legible e indentación de 2 espacios. Las respuestas devuelven los bytes JSON sin procesar por defecto, o metadatos con una URL de descarga prefirmada cuando direct_download=false.

Endpoint#

POST /v1/convert/yaml-to-json

Content-Type: multipart/form-data

Entrada aceptada: archivos .yaml o .yml (codificados en UTF-8)

Formato de salida: .json (application/json)

Autenticación#

Requiere una clave API privada o un token JWT obtenido de una clave pública.

X-API-Key: sk_your_private_key

O bien:

Authorization: Bearer <jwt_token>

Parámetros de la petición#

Reglas de conversión#

Mapeo directo de YAML a JSON:

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

Se convierte en:

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

• Usa parseo seguro -- sin construcción de objetos Python arbitrarios a partir de etiquetas YAML
• Los tipos YAML se mapean de forma natural: strings, números, booleanos, nulls, arrays, objetos
• La salida tiene indentación de 2 espacios con unicode preservado

Respuesta#

Descarga directa (direct_download=true, por defecto)#

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

Respuesta con metadatos (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
}

Ejemplos de código#

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)

Respuestas de error#

Límites#

Preguntas frecuentes#

¿Cómo convierto YAML a JSON con una API REST?#

Envía una petición POST multipart/form-data a /v1/convert/yaml-to-json con tu archivo .yaml o .yml en el campo file, autenticada con una cabecera X-API-Key o un token JWT Authorization: Bearer. La respuesta es JSON con formato legible e indentación de 2 espacios.

¿Es seguro convertir archivos YAML no confiables a JSON?#

El endpoint usa parseo seguro: sin construcción de objetos Python arbitrarios a partir de etiquetas YAML y sin ejecución de código arbitrario. Los tipos YAML se mapean de forma natural a strings, números, booleanos, nulls, arrays y objetos JSON.

¿Puedo convertir archivos YAML multidocumento a JSON?#

Solo se convierte el primer documento YAML. En los archivos con varios documentos separados por ---, todo lo que sigue al primer documento no se procesa.

¿Se aceptan archivos .yml además de .yaml?#

Sí. Se aceptan tanto la extensión .yaml como .yml; cualquier otra extensión devuelve 400 Bad Request. Los archivos deben estar codificados en UTF-8.

¿Puedo obtener una URL de descarga prefirmada en lugar de los bytes JSON sin procesar?#

Sí. Establece direct_download=false para recibir metadatos con presigned_url, object_key, filename, file_size y conversion_time_seconds.