El módulo de API de Apidog incluye dos modos que se pueden alternar en la esquina inferior izquierda de la interfaz: Modo de diseño primero y Modo de petición primero.Ambos modos ofrecen funcionalidades similares, pero con interfaces diferentes, adaptadas a distintos flujos de trabajo de equipo.El Modo de diseño primero es el modo recomendado por Apidog, adecuado para equipos que siguen el enfoque API-Design First. En este modo, los equipos especifican primero la API y luego continúan con el desarrollo y las pruebas en función de la especificación de la API.Por otro lado, el Modo de petición primero es ideal para equipos que no definen inicialmente las especificaciones de la API. Estos equipos suelen centrarse en el desarrollo backend, finalizar el código y luego producir la especificación de la API para que puedan comenzar las pruebas y el trabajo del lado del cliente.Si necesita llamar a API desarrolladas por otra persona pero no dispone de la documentación, también debe utilizar el Modo de petición primero.
Modo de diseño primero#
En el Modo de diseño primero, la edición de la especificación de la API y el envío de peticiones se realizan mediante pestañas separadas. Los usuarios modifican la especificación de la API en la pestaña Editar y envían peticiones en la pestaña Ejecutar.Esta separación se adapta a los equipos que siguen el enfoque API-Design First, donde los arquitectos de API y los desarrolladores/consumidores tienen roles distintos. Los arquitectos de API definen la especificación de la API sin enviar peticiones, mientras que los desarrolladores se centran en el desarrollo y las pruebas de la API sin modificar la especificación de la API.Las pestañas divididas se alinean con los hábitos de uso de dichos equipos. En la pestaña Editar, los arquitectos de API pueden especificar ejemplos de petición, que se establecen automáticamente como valores predeterminados de parámetros en la pestaña Ejecutar. Los desarrolladores/consumidores de API pueden modificar adicionalmente los valores de los parámetros y los cuerpos de petición en la pestaña Ejecutar.Modo de petición primero#
El Modo de petición primero es adecuado para equipos que no especifican las API de antemano. Los desarrolladores backend trabajan directamente en el desarrollo de API y pueden necesitar llamar a API para depurar durante el desarrollo.En este modo, los desarrolladores no necesitan especificar inicialmente la API; en su lugar, pueden introducir una petición directamente, de forma similar a crear una nueva petición en Postman. En esta interfaz, los desarrolladores pueden modificar fácilmente tipos de parámetros, nombres, valores, componentes del cuerpo y más, sin necesidad de ajustar por separado la especificación de la API y los valores de los parámetros de petición.Una vez completada y guardada la depuración, la petición se analiza automáticamente para convertirla en una especificación de endpoint. Los parámetros se traducen en parámetros de especificación y valores de ejemplo, mientras que el cuerpo de la petición/respuesta se analiza para convertirlo en un esquema, y los valores del cuerpo se interpretan como ejemplos de petición/respuesta. Los desarrolladores pueden perfeccionar y mejorar adicionalmente esta especificación de endpoint en función de sus requisitos.Diferencias entre modos#
La diferencia clave entre los dos modos es que, en el Modo de petición primero, el cuerpo de la petición se utiliza como ejemplo de cuerpo de petición del endpoint. En cambio, en el Modo de diseño primero, los usuarios pueden introducir un cuerpo de petición real en la pestaña Ejecutar junto con el ejemplo de cuerpo de petición. Por lo tanto, la sección del cuerpo en la pestaña Ejecutar SOLO está disponible en el Modo de diseño primero y no es visible en el Modo de petición primero.Otra diferencia es que, en el Modo de diseño primero, usted puede añadir un pre/postprocesador en el nivel de especificación del endpoint o en el nivel de caso de ejecución/endpoint. Mientras que, en el Modo de petición primero, dado que no existe la pestaña Ejecutar, todos los pre/postprocesadores se consideran en el nivel de especificación del endpoint. Los pre/postprocesadores del nivel de caso de ejecución/endpoint no son visibles en el Modo de petición primero. 