Referencias de API

DeveloperHub genera Referencias de API atractivas y potentes a partir de tus definiciones de API. Crea, sube, combina o edita tus definiciones de OpenAPI directamente en DeveloperHub.

Consulta aquí nuestras propias Referencias de API.

Características

Tus atractivas Referencias de API constan de:

• Un encabezado de título con un resumen.

• Todas las URL de servidor disponibles.

• Métodos de autenticación.

• Todas las operaciones, agrupadas por etiquetas.

• Todos los webhooks (OAS 3.1+).

Cada operación muestra lo siguiente:

• Resumen e información.

• Encabezados.

• Tipos de medios de la solicitud y la respuesta.

• Parámetros de consulta, parámetros de ruta, datos del cuerpo y datos de formulario.

• Códigos de respuesta y cuerpos de respuesta.

• Restricciones de las propiedades.

• Ejemplo de solicitud generado automáticamente con distintas bibliotecas.

• Ejemplos de respuesta generados automáticamente.

• Callbacks.

Puedes enlazar directamente a las referencias de API desde la documentación siguiendo los pasos de enlaces entre páginas.

Pruébalo

Los lectores pueden probar tu API directamente desde la Referencia de API.

Personalización de la Referencia de API

Puedes personalizar tus referencias de API, de modo que tus lectores no tengan que obtener las variables dinámicas de distintos lugares. Consulta variables y documentación personalizada para la implementación.

Especificaciones compatibles

Admitimos OpenAPI 3.2, 3.1, 3.0 y OpenAPI 2.0 (el antiguo Swagger).

Tipo de archivo

Se admiten estos tipos:

• Archivos JSON - .json

• Archivos YAML - .yaml