Este artículo presenta los conceptos principales de Apidog, una herramienta API-first diseñada para un diseño, pruebas y colaboración de API eficientes. Muchos conceptos difieren de productos similares como Postman. Comprenderlos le ayudará a navegar de forma eficaz por el flujo de trabajo de Apidog.Proyecto#
Un Proyecto en Apidog es la unidad principal de colaboración, que contiene módulos, entornos, escenarios de prueba y mucho más. Sirve como contenedor para todo el trabajo relacionado con API dentro de un equipo.Componentes clave de un proyecto#
Módulos: Agrupaciones lógicas de endpoints y componentes relacionados.
Entornos: Conjuntos de variables para diferentes etapas de implementación (por ejemplo, desarrollo, staging, producción).
Escenarios de prueba: Colecciones de peticiones para pruebas automatizadas.
Especificaciones de endpoint: Documentación de API basada en los estándares OpenAPI/Swagger.
Comparación con Postman#
| Concepto de Apidog | Equivalente en Postman | Descripción |
|---|
| Proyecto | Workspace | Unidad organizativa de nivel superior para la colaboración. |
| Módulo | Collection Folder | Agrupa endpoints relacionados. |
| Equipo | Team | Funciones de acceso compartido y colaboración. |
Los proyectos permiten una colaboración fluida, lo que permite que varios usuarios trabajen en API simultáneamente mientras se mantiene el control de versiones y los permisos de acceso.
Módulo#
Un Módulo organiza endpoints de forma lógica dentro de un proyecto, de manera similar a un "servicio" en una arquitectura de microservicios. Cada módulo representa un archivo de especificación OpenAPI independiente.Funciones de un módulo#
Contiene endpoints, esquemas, respuestas y esquemas de seguridad relacionados.
Se configura con una Base URL por entorno para la generación automática de URL.
Admite operaciones de importación/exportación a nivel de módulo para mejorar el cumplimiento de estándares.
Cuándo usar módulos#
Para microservicios: cada servicio como un módulo separado.
Para varias API: agrupe endpoints por funcionalidad o dominio.
Predeterminado: los proyectos nuevos comienzan con un módulo; añada más según sea necesario para varias URL base.
Los módulos se alinean con la Especificación OpenAPI (OAS), lo que facilita la integración con otras herramientas y mantiene límites de API claros.
Endpoint#
Un Endpoint es el elemento principal en el enfoque API-first de Apidog, y representa una operación de API específica (por ejemplo, GET /users/{id}).Gestión de endpoints#
Se agrupan en estructuras de directorios para su organización.
Se vincula a casos de endpoint para ejemplos de peticiones guardadas.
Diferencias con Postman#
| Aspecto | Apidog (basado en endpoints) | Postman (basado en peticiones) |
|---|
| Unidad básica | Endpoint (especificación de API) | Petición (llamada individual) |
| Cambios en la especificación | Actualiza automáticamente casos y pruebas | Requiere reescritura manual |
| Estructura | Extensión OAS con depuración | Especificaciones y peticiones separadas |
En Apidog, los cambios en las especificaciones de endpoint se propagan automáticamente a todos los casos dependientes, lo que reduce la carga de mantenimiento mediante este enfoque basado en especificaciones.
Entorno#
Un Entorno gestiona variables y URL base para diferentes contextos de implementación, lo que permite cambiar sin problemas entre desarrollo, staging y producción.Funciones clave#
Contiene variables de entorno para valores dinámicos.
Admite varias Base URLs por entorno para microservicios. Construcción automática de URL: Base URL + Ruta del endpoint.
Ejemplo de Base URL#
Suponga un proyecto con tres servicios:| Servicio | Base URL (Prod) | Ruta del endpoint | URL completa |
|---|
| Usuario | https://user.example.com | GET /user/{id} | https://user.example.com/user/{id} |
| Pedido | https://order.example.com | GET /order/{id} | https://order.example.com/order/{id} |
| Producto | https://product.example.com | GET /product/{id} | https://product.example.com/product/{id} |
No es necesario usar marcadores de posición manuales {{BaseUrl}}; Apidog detecta el módulo y aplica automáticamente la URL base correcta.
Petición#
Una Petición es una llamada de API independiente, no vinculada a especificaciones de endpoint, similar a las peticiones de Postman.Capacidades de las peticiones#
Crear de forma independiente de las especificaciones. Analizar peticiones correctas para convertirlas en especificaciones de endpoint. Úsela para pruebas ad hoc o API no documentadas.
Las peticiones proporcionan flexibilidad para escenarios en los que las especificaciones de API no están predefinidas, cerrando la brecha entre los flujos de trabajo design-first y request-first.
Escenario de prueba#
Un Escenario de prueba ejecuta lotes de peticiones, de forma similar a las Collections de Postman, con funciones avanzadas de automatización.Funciones#
Paso de datos entre peticiones. Capacidades avanzadas#
Informes de prueba y pruebas de rendimiento.
Pruebas basadas en datos.
Los escenarios de prueba se sincronizan automáticamente con los cambios en las especificaciones de API, lo que garantiza que las pruebas sigan siendo válidas a medida que las API evolucionan.
Modo design-first y modo request-first#
El módulo de API de Apidog cuenta con dos modos que se pueden cambiar en la esquina inferior izquierda de la interfaz: Design-first Mode y Request-first Mode.Ambos modos proporcionan funcionalidades similares, pero con interfaces diferentes, adaptadas a distintos flujos de trabajo de equipo.Modo design-first#
Recomendado para equipos que practican primero el diseño de API.
Defina especificaciones de API antes del desarrollo y las pruebas.
Ideal para proyectos planificados y basados en especificaciones.
Modo request-first#
Adecuado para equipos que se centran primero en el desarrollo backend.
Cree peticiones y luego genere especificaciones a partir de llamadas correctas.
Perfecto para API no documentadas o integraciones de terceros.
Resumen#
Comprender estos conceptos principales le ayudará a aprovechar el enfoque API-first de Apidog para un diseño, pruebas y colaboración eficientes. Comience creando un proyecto, organice endpoints en módulos, defina entornos para diferentes etapas y cree escenarios de prueba para la automatización.Para obtener más información, explore las páginas de documentación enlazadas o pruebe la interfaz de Apidog para ver estos conceptos en acción.
¿Está listo para comenzar?#
Comenzar desde cero
Empiece con Apidog desde ceroMigrar a Apidog
Comience migrando a Apidog 