Conceptos básicos de endpoints
Creación de un endpoint
APIs, haga clic en el botón Nuevo endpoint.1.
2.
3.
4.
5.
Modo Design-first
Modo Request-first
Modos de interfaz
Ruta del endpoint
/users). La URL base se establece en el entorno, y Apidog la añade automáticamente al realizar peticiones al endpoint./. Esto mantiene el diseño de su API limpio y organizado, y garantiza que obtenga todo el beneficio de las funciones de Apidog.Por qué iniciar las rutas con /
/ para cumplir con la OAS. No iniciar las rutas con / puede provocar diversos problemas de compatibilidad al usar herramientas dentro del ecosistema OpenAPI./ al principio de las rutas permite utilizar la funcionalidad de mock de patrón de URL, esencial para fines de prueba y validación en Apidog.Método de petición
| Método | Descripción |
|---|---|
| GET | Recupera recursos especificados sin efectos secundarios. Usa parámetros de consulta para transmitir datos. |
| POST | Envía datos para su procesamiento y puede tener efectos secundarios. Los datos normalmente se envían en el cuerpo de la petición. |
| PUT | Actualiza o reemplaza por completo recursos especificados. |
| DELETE | Elimina recursos especificados. |
| OPTIONS | Consulta los métodos HTTP admitidos por el recurso de destino. |
| HEAD | Similar a GET, pero solo recupera los encabezados de la respuesta. Resulta útil para comprobar la existencia y las modificaciones de recursos sin descargar el contenido del recurso. |
| PATCH | Actualiza información parcial de recursos especificados. |
| TRACE | Devuelve la petición recibida por el servidor. Se utiliza principalmente con fines de depuración y diagnóstico. |
| CONNECT | Establece un túnel hacia el servidor, normalmente utilizado para el reenvío de peticiones de servidores proxy. |
Metadatos del endpoint
| Campo | Descripción |
|---|---|
| Nombre | Un nombre descriptivo que resume la funcionalidad del endpoint. |
| Estado | El estado predeterminado es "En desarrollo". Puede modificarlo para reflejar distintas etapas, como Pruebas o Producción. Obtenga más información sobre el estado del endpoint. |
| Responsable de mantenimiento | Especifica el miembro del equipo de Apidog responsable del endpoint. Seleccione un usuario de su cuenta para asignarle este rol. |
| Etiquetas | Palabras clave o frases que categorizan o describen el endpoint. Puede crear nuevas etiquetas o seleccionar entre las existentes. |
| Servicio | La URL base a la que se añade la ruta del endpoint. De forma predeterminada, se establece en "Heredar de los elementos principales", pero puede especificarse manualmente mediante la configuración del entorno. Obtenga más información sobre Entornos y servicios. |
| OperationId | Un identificador único (operationId en OAS) que distingue esta operación dentro de la API. |
| Descripción | Información detallada sobre el propósito y el uso del endpoint, con compatibilidad con Markdown para un formato mejorado. |
Campos personalizados
Petición
Parámetros de petición
Parámetros de consulta
?, y separados por & de la siguiente manera: ?id=2&status=available. Se utilizan para filtrar, ordenar o modificar la salida de un endpoint de API.INFO
Parámetros de ruta
/pets/{id}, ejemplo incorrecto: /pets/:id.{parameter} en la URL y, a continuación, usar {{variable}} para el valor del parámetro. Por ejemplo:Recomendado: coloque la variable en el valor del parámetro de ruta
No recomendado: coloque la variable directamente en la URL
No confunda {parameter} y {{variable}}
{parameter}: las llaves simples representan parámetros de ruta en Apidog. Los parámetros de ruta son marcadores de posición en la ruta de la URL que cambian dinámicamente a valores específicos cuando se accede al endpoint de API.{{variable}}: las llaves dobles incluyen variables dentro de las peticiones. Estas variables pueden sustituirse por valores reales cuando se envía la petición, lo que permite una entrada dinámica y personalizable en las interacciones con la API.Por qué NO usar {{variable}} en la ruta
{{variable}} no cumple con la OAS. Seguir la OAS permite una integración fluida con diversas herramientas dentro del ecosistema OpenAPI.{{variable}} en la ruta impedirá el uso de la funcionalidad de mock de patrón de URL en Apidog.Parámetros de encabezado
Más información
Parámetros de cuerpo
Más información
Descripción de parámetros
| Propiedad | Descripción |
|---|---|
| Nombre | Especifica el nombre del parámetro que se describe. Es un campo obligatorio y debe representar con precisión el parámetro que se está definiendo. |
| Tipo | Especifica el tipo de datos del valor del parámetro. Los valores comunes incluyen string, number, integer, boolean, array, object y más. Esta propiedad ayuda a definir el formato y la estructura del valor del parámetro. |
| Descripción | Proporciona una breve explicación o documentación sobre el parámetro. Ayuda a los usuarios a comprender el propósito y el uso del parámetro. |
| Obligatorio | Especifica si el parámetro es obligatorio para la petición de API. Es un valor booleano (true o false) que indica si el parámetro debe incluirse en la petición. |
| Configuración avanzada | Define el tipo de datos, el formato y las restricciones del parámetro. Le permite proporcionar información detallada sobre la estructura y el contenido esperados del valor del parámetro. |
Editor de tipos
Esquemas
JSON o XML, debe configurarse la estructura de datos. La estructura de datos puede hacer referencia a los esquemas.Más información
Respuesta y ejemplo
| Componente | Descripción |
|---|---|
| Código de estado HTTP | Determine todos los posibles estados de respuesta que su endpoint podría devolver, incluidas respuestas estándar como 200 (OK), 404 (Not Found) o 500 (Server Error). |
| Formato de datos | Defina el formato de la respuesta que la API devolverá para cada código de estado. Podría estar en JSON, XML, HTML, Raw, Binary o cualquier otro formato adecuado. |
| Esquema | Para las respuestas que transportan datos (principalmente el estado 200), detalle la estructura de la carga útil de la respuesta. Esto incluye especificar tipos, objetos anidados, campos opcionales y matrices. Las definiciones claras ayudan a los desarrolladores cliente a comprender qué datos esperar y cómo analizarlos. Solo JSON y XML pueden configurar esquemas. Para obtener información detallada, consulte Esquemas. |
| Ejemplo | Proporcionar una respuesta de ejemplo es esencial para ilustrar cómo se comporta la API en escenarios reales. Idealmente, un ejemplo debe ser un conjunto de datos de muestra devuelto por el servidor cuando se invoca el endpoint con una petición predefinida. Debe reflejar la estructura, el formato de datos y los tipos definidos por el esquema de la respuesta. |
Añadir respuestas
200 OK suelen diferir entre diversos 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, haciendo que el proceso de documentación de la API sea más eficiente y que el comportamiento de la API sea más coherente.Componentes de respuesta
Añadir ejemplos de respuesta
Generación automática de ejemplos
Vista previa del endpoint
Modified at 2026-06-09 08:52:14