Componentes

Normalmente, en el diseño de API, aunque las respuestas correctas 200 OK suelen diferir entre varios endpoints debido a necesidades distintas de datos de salida, las respuestas de error como 400 Bad Request y 404 Not Found tienden a ser coherentes entre distintos endpoints.

Apidog aborda de forma inteligente esta característica común con su función Componente de respuesta, que permite reutilizar respuestas de error predefinidas, lo que hace que el proceso de documentación de la API sea más eficiente y que el comportamiento de la API sea más coherente.

Compatibilidad con OAS

La función Componente de respuesta en Apidog es compatible con los Components en OAS.

Añadir un componente de respuesta

En el árbol de directorios izquierdo del módulo APIs, navegue hasta la sección Componentes y, a continuación, haga clic en Nueva respuesta en Respuestas para crear un nuevo componente de respuesta.

Crear un componente de respuesta es similar a especificar la sección de respuesta al definir un endpoint en cuanto a incluir código de estado HTTP, tipo de contenido, esquema y ejemplos. Para obtener orientación detallada, consulte la sección Respuesta en Conceptos básicos de endpoints.

Función única del componente de respuesta

Añadido en nuevos endpoints de forma predeterminada: cuando se selecciona como "Sí", este componente se incluirá automáticamente en todos los endpoints nuevos añadidos al proyecto de forma predeterminada.

INFO

Los endpoints existentes no se ven afectados por esta configuración.

Referenciar componentes de respuesta

En la sección Respuesta de un endpoint, puede referenciar un componente de respuesta predefinido.

Puntos clave sobre los componentes referenciados:

Los componentes de respuesta referenciados no se pueden modificar dentro del endpoint. Debe realizar los cambios en el componente de respuesta original. Cualquier modificación realizada afectará a todos los endpoints que referencien este componente.

Si desea modificar un componente de respuesta que se ha referenciado en un endpoint, puede quitar la referencia. Quitar la referencia convertirá la respuesta en una respuesta normal editable, y los cambios en el componente de respuesta ya no la afectarán.

En un endpoint, un componente solo puede referenciarse una vez; varias instancias del mismo componente no pueden coexistir dentro del mismo endpoint.

Operaciones por lotes

Puede Añadir de forma masiva los componentes de respuesta existentes a los endpoints seleccionados, o Eliminar este componente de forma masiva de los endpoints seleccionados.

Notas:

Si el endpoint seleccionado ya incluye este componente de respuesta, no se añadirá de nuevo.

Si el endpoint seleccionado no contiene este componente de respuesta, la acción de eliminación no surtirá efecto.

Plantilla de respuesta predeterminada

Muchas empresas tienen una estructura estandarizada para sus respuestas. En estos casos, puede aprovechar la Plantilla de respuesta predeterminada para mantener la estructura fija de la empresa como plantilla de respuesta predeterminada.

En el árbol de directorios izquierdo, bajo la sección Componentes, puede acceder a la función Plantilla de respuesta predeterminada y utilizarla.

Cuando se crea un nuevo endpoint, el contenido de esta plantilla se utiliza como respuesta inicial.

Características clave:

Los cambios realizados en la plantilla de respuesta predeterminada afectarán solo a los endpoints nuevos, y los existentes permanecerán sin cambios.

Existe una única plantilla de respuesta predeterminada, que no se puede añadir ni eliminar.

La plantilla de respuesta predeterminada inicial es una respuesta 200 Success con un tipo de contenido JSON y una estructura de datos de un nodo Object vacío.

Preguntas frecuentes

P: ¿Puedo utilizar un componente de respuesta como respuesta predeterminada?

R: No, los componentes de respuesta están destinados a respuestas de error genéricas como 400, 404 y códigos de estado similares. Si necesita utilizar una respuesta predeterminada fija, utilice la plantilla de respuesta predeterminada.

Añadir un componente de respuesta#

Función única del componente de respuesta#

Referenciar componentes de respuesta#

Operaciones por lotes#

Plantilla de respuesta predeterminada#

Preguntas frecuentes#

Añadir un componente de respuesta

Función única del componente de respuesta

Referenciar componentes de respuesta

Operaciones por lotes

Plantilla de respuesta predeterminada

Preguntas frecuentes