Skip to content

Compatibilidad con OpenAPI (Swagger)

El poder de las herramientas de Swagger comienza con la Especificación de OpenAPI — el estándar de la industria para el diseño de API RESTful

Descripción general de Swagger

Swagger ofrece las herramientas más potentes y fáciles de usar para aprovechar al máximo la Especificación de OpenAPI. Estas herramientas pueden ayudarle a diseñar, construir, documentar y consumir API REST.

Descripción general de OpenAPI

Especificación de OpenAPI (anteriormente Especificación de Swagger) es un formato de descripción de API para API REST. Un archivo de OpenAPI le permite describir su API completa, incluyendo:

  • Puntos finales disponibles (/users) y operaciones en cada punto final (GET /users, POST /users)

Configurar puntos finales

  • Parámetros de operación Entrada y salida para cada operación

Establecer parámetros de puntos finales/Aplicaciones

  • Métodos de autenticación
  • Información de contacto, licencia, términos de uso y otra información

Las especificaciones de API se pueden escribir en YAML o JSON. El formato es fácil de aprender y legible tanto para humanos como para máquinas. La especificación completa de OpenAPI se puede encontrar en GitHub: Especificación de OpenAPI 3.0. Más información sobre OpenAPI aquí.

Demostración de Swagger

Especificar la definición de Swagger

En este punto, puede especificar una URL de archivo de Swagger (json/yaml) o Cargar una definición. Una vez cargada, aparecerá una Configurar puntos finales.

El lado izquierdo del cuadro de diálogo Configurar puntos finales consta de:

  • URL base - se puede rellenar automáticamente si el valor para ella está presente en la definición del archivo
  • Autorización - proporcione la clave de autenticación si es necesaria
  • Vista de árbol de puntos finales - Todos los puntos finales disponibles se cargarán aquí junto con su tipo (GET, PUT, POST, etc.)

El lado derecho del cuadro de diálogo Configurar puntos finales consta de:

  • URL de solicitud con botón Enviar que se puede usar para probar la conexión antes de seleccionarla
  • Elementos de pestañas para autorización, parámetros y encabezados - si uno es requerido, se marcará como tal.
  • Sección de contenido de pestaña que muestra mensajes de información o campos obligatorios. Imagen de ejemplo:

Cuadro de diálogo Configurar puntos finales

Usar origen de datos de fuentes de red local

Ahora puede realizar solicitudes a localhost o redes privadas. Para obtener más información, consulte la sección de uso de redes privadas del tema Usar datos en su aplicación

Uso de fuentes de red local

Recursos adicionales