Referencias de API, compatibilidad con GraphQL y un playground renovado

Antes, las referencias de API eran exclusivamente REST, y consultar una significaba recorrer una lista sencilla de endpoints. Ahora Ferndesk publica referencias completas para REST y GraphQL, con diseños de barra lateral reales y un playground que puedes probar directamente.

• 📘 Compatibilidad con GraphQL: publica API de GraphQL a partir de un archivo SDL, una exportación JSON de introspección o un endpoint activo

• 🗂️ Nuevos diseños de barra lateral para API: Plano, Carpetas y Contraído, con orden e iconos de grupo personalizados

• 🚀 Un playground renovado: envía solicitudes reales con Pruébalo para REST y un playground completo para GraphQL

• 🔄 Fuentes que permanecen sincronizadas: carga una especificación, obtén los cambios de GitHub con cada push o indica una URL que se actualice automáticamente

Compatibilidad con GraphQL

Las API de GraphQL ahora son una parte fundamental. Indica a Ferndesk un archivo SDL de GraphQL, una exportación JSON de introspección o un endpoint activo con la introspección habilitada, y obtendrás páginas de tipos generadas junto con tus operaciones.

Tú decides cuánto del esquema pueden ver los lectores. Una opción Mostrar tipos añade una sección Tipos a la barra lateral, y puedes ocultar tipos individuales del mismo modo que ocultas operaciones y esquemas REST.

Los lectores exploran tu esquema en el playground de GraphQL, que está restringido al endpoint que configures para la referencia. Consulta Personalizar una referencia de API.

Nuevos diseños de barra lateral para referencias de API

Elige cómo navegar por tu referencia: Plano para una sola lista, Carpetas para endpoints agrupados o Contraído para mantener ordenadas las referencias largas. Reorganiza los grupos, añade iconos y muestra u oculta operaciones, esquemas y tipos individuales.

Las ediciones se conservan al volver a procesar. Reemplaza o actualiza la fuente y tus resúmenes, notas en Markdown, ejemplos de código personalizados y opciones de diseño permanecerán intactos.

Un playground renovado

El botón Pruébalo abre el playground integrado de Ferndesk directamente en la página de la operación. Edita parámetros, encabezados, cookies y el cuerpo de la solicitud, elige un servidor y envíala. Las respuestas se muestran junto a la solicitud, y el historial de solicitudes permanece disponible mientras exploras. Consulta Usar el playground de referencias de API.

Fuentes que permanecen sincronizadas

Carga un archivo de especificación de OpenAPI, Swagger o GraphQL, obtén la especificación de un repositorio de GitHub o indica una URL.

Las fuentes de GitHub se vuelven a sincronizar automáticamente cuando un push cambia el archivo de especificación, utilizando de forma predeterminada la rama de producción de tu repositorio. Las fuentes de URL se actualizan automáticamente cada seis horas, y puedes actualizar cualquiera de las dos manualmente cuando quieras. La configuración de una fuente se explica en Crear una referencia de API, y cómo mantenerla en buen estado, en Solucionar errores de fuentes de referencias de API.