Resolución de problemas de configuración de especificaciones de API

URL del servidor faltante o incorrecta en la especificación de OpenAPI

Cuando ocurre: El botón Pruébalo! no aparece, o los consumidores de la API no están seguros de qué URL base usar para sus solicitudes.

Por qué ocurre: La servers sección falta en la especificación de OpenAPI o contiene una URL incorrecta. Sin ella, los usuarios de la API no pueden determinar dónde enviar solicitudes y las herramientas de documentación no pueden llenar la función Pruébalo!.

Cómo solucionarlo:

1. Añade una sección correcta servers a tu especificación:

   servers:
     - url: https://api.yourdomain.com
       description: Production

2. Para APIs específicas de región, define múltiples entradas de servidor:

   servers:
     - url: https://api.yourdomain.com
       description: Global
     - url: https://api.us.yourdomain.com
       description: US region

3. Asegúrate de que todos los clientes API (por ejemplo, Postman, cURL) usen la URL correcta del servidor al hacer solicitudes.

i️ NOTA
Las URLs anteriores son ejemplos. Usa la URL base real de tu API.

Cuerpo vacío mostrado en la documentación de la API

Cuando ocurre: El cuerpo de la solicitud de un endpoint aparece como vacío en la documentación publicada.

Por qué ocurre: El esquema OpenAPI falta "type": "object" en una o más definiciones de objetos.

Cómo solucionarlo: Asegúrate de que cada definición de objeto en tu especificación OpenAPI incluya "type": "object". Este atributo indica a Document360 cómo renderizar con precisión los parámetros del cuerpo de las solicitudes y los esquemas de respuesta, facilitando que los desarrolladores comprendan e interactúen con tu API.