- Centro de aprendizaje de Apidog
- Primeros pasos
- Datos de API mock
- Cuenta y preferencias
- Enviar peticiones
- Desarrollar y depurar APIs
- Descripción general
- Generación de peticiones
- Envío de peticiones
- Casos de depuración
- Casos de prueba
- Valores dinámicos
- Validación de respuestas
- Diseño primero vs. petición primero
- Generación de código
- Entornos y variables
- Secretos de la bóveda
- Módulos de valores dinámicos
- Preprocesadores y postprocesadores
- Depuración de APIs
- Diseñar APIs
- Descripción general
- Crear un nuevo proyecto de API
- Conceptos básicos de endpoints
- Directrices de diseño de API
- Módulo
- Configurar múltiples ejemplos de cuerpo de petición
- Componentes
- Campos comunes
- Parámetros globales
- Historial de cambios del endpoint
- Comentarios
- Gestión de endpoints por lotes
- API de protocolo personalizado
- Modo Spec-first (Beta)
- Esquemas de seguridad
- Funciones avanzadas
- Schemas
- Pruebas de API
- Publicar documentación de API
- Descripción general
- Tecnologías de API compatibles
- Uso compartido rápido
- Visualización de la documentación de API
- Documentación de Markdown
- Publicación de sitios de documentación
- Página de inicio de sesión personalizada
- Diseños personalizados
- CSS, JavaScript, HTML personalizados
- Dominio personalizado
- Funciones de IA
- Configuración de SEO
- Configuración avanzada
- Versiones de API
- Ramas
- Funciones de IA
- Servidor MCP de Apidog
- Mejores prácticas
- Espacio sin conexión
- Administración
- Facturación
- Complementos
- Datos y seguridad
- Referencias
- Enfoque de diseño de API primero
- Extensiones de la especificación OpenAPI de Apidog
- JSONPath
- XPath
- Expresiones regulares
- JSON Schema
- Formato de archivo CSV
- Instalación del entorno Java
- Entorno de implementación de Runner
- Sintaxis Markdown de Apidog
- Extensiones Swagger de Apidog
- Extensiones JSON Schema de Apidog
- Apidog Europa
- Centro de soporte
- Apidog Support Center
- Importar/exportar
- Envío de peticiones
- ¿Admite Apidog Socket.IO?
- ¿Por qué el signo "+" en el valor del parámetro se decodifica como un espacio?
- ¿Cómo enviar una petición en Apidog?
- ¿Cómo enviar una petición GraphQL en Apidog?
- ¿Cómo enviar una petición gRPC en Apidog?
- ¿Cómo enviar una petición SOAP/WebService en Apidog?
- ¿Cómo enviar una petición WebSocket en Apidog?
- ¿Admite Apidog scripts previos a la petición/scripts de prueba y aserciones en las API WebSocket?
- ¿Cómo enviar una petición SSE en Apidog?
- ¿Cómo añadir encabezados predeterminados a nivel de carpeta?
- ¿Admite Apidog scripts de pre-petición/prueba y aserciones en las API gRPC?
- Error del resolvedor DNS ELANREFUSED.DNS
- ¿Por qué recibo un error "socket hang up" al enviar una petición?
- Corrección de errores de petición
- Diseño de APIs
- ¿Cómo uso variables en la ruta?
- ¿Puedo usar un componente de respuesta como respuesta predeterminada?
- ¿Cómo comprobar quién ha modificado un endpoint?
- ¿Cómo puedo eliminar carpetas de endpoints de forma masiva en Apidog?
- ¿Cómo puedo agregar o eliminar prefijos de forma masiva en la ruta de los endpoints?
- ¿Cómo mover el nivel de una propiedad en el Editor de esquemas?
- Si una propiedad de cadena tiene varios valores enumerados y se utiliza en varias ubicaciones, ¿cómo se puede referenciar este enum de forma coherente en todas ellas?
- ¿Cómo obtener el ID de la carpeta de recursos de Apidog?
- ¿Cómo obtengo el ID de la carpeta de recursos de Apidog?
- ¿Cómo uso variables en una ruta de URL?
- ¿Qué debo hacer si un endpoint, documento o escenario de prueba se elimina accidentalmente?
- ¿Apidog admite código de petición para endpoints personalizados?
- ¿Cómo agrupar automáticamente endpoints al importar Swagger/OpenAPI en Apidog?
- ¿Cómo genero datos de matriz no duplicados en respuestas mock?
- ¿Por qué no se admite la entrada "#" en la ruta?
- Depuración de APIs
- ¿Cómo se integra Apidog con sistemas de gestión de claves de terceros?
- ¿Por qué la misma petición funciona correctamente en otras herramientas (como Postman) pero no en Apidog?
- ¿Cómo obtener valores de variables desde una base de datos en Apidog?
- ¿Cómo migrar entornos desde otras herramientas a Apidog?
- ¿Cómo realizar aserciones usando scripts en Apidog?
- JSONPath solo puede extraer arrays. ¿Cómo puede extraer un solo elemento de ellos en Apidog?
- ¿Cómo configurar operaciones de base de datos en Apidog cuando diferentes entornos tienen distintas credenciales de cuenta de base de datos?
- ¿Cómo obtener la URL base del servicio en un script personalizado?
- ¿Por qué Apidog informa un error que supera la longitud máxima de cadena de Node.js cuando la respuesta de la API es demasiado grande?
- ¿Cuál es el límite de tamaño para la impresión en consola? ¿Por qué aparece un error al imprimir archivos grandes?
- ¿Cómo resolver errores de conexión a la base de datos DB2 en Windows?
- ¿Por qué aparece el error NJS-045 al conectarme a una base de datos Oracle en Apidog?
- ¿Cómo generar valores dinámicos en scripts personalizados de Apidog?
- ¿Por qué la petición del cliente al mismo endpoint se realiza correctamente, pero se produce un error al depurar en el lado web: "No se puede solicitar la dirección"?
- ¿Por qué Apidog informa un error cuando la respuesta es demasiado grande?
- ¿Cómo utilizo el endpoint de registro de Apidog?
- Al definir la respuesta de un endpoint, ¿se permite que el endpoint no tenga contenido de respuesta?
- ¿Cómo obtengo la baseURL del servicio en un script personalizado?
- ¿Cómo puedo ver el paquete original en Apidog?
- ¿Por qué veo el error "Invalid URI xxx" al realizar una petición?
- ¿Cómo realizo una petición asíncrona en un script de Apidog?
- ¿Por qué veo el mensaje "Couldn't resolve host" al enviar una petición?
- ¿Cuál es el límite de tamaño de impresión de la consola? ¿Por qué aparece un error cuando imprimo un archivo grande?
- ¿Cómo puedo cargar un archivo en una petición de endpoint?
- ¿Qué hacer si Apidog se bloquea o los datos de respuesta no se muestran?
- URI de redirección oficial utilizada por Apidog para OAuth2.0
- Datos de API mock
- ¿Cómo hacer mock de APIs automáticamente?
- ¿Qué puede hacer el mock de Apidog?
- ¿Cómo simular datos fijos de API en Apidog?
- ¿Cómo simular datos condicionales en Apidog?
- ¿Cómo habilitar el mock en la nube en Apidog?
- ¿Cómo habilitar un mock autoalojado en Apidog?
- ¿Apidog admite mocks de API WebSocket?
- ¿Por qué el navegador no devuelve contenido al solicitar el endpoint mock?
- Pruebas automatizadas
- ¿Por qué los escenarios de prueba se ejecutan sin problemas en mi cliente local, pero se producen errores al ejecutarlos en Apidog CLI o runner?
- ¿Cómo crear un escenario de prueba en Apidog?
- ¿Cómo pasar datos entre pasos de prueba?
- ¿Por qué no puedo referenciar correctamente los datos del paso previo?
- ¿Cómo usar el bucle foreach en Apidog?
- ¿Cuáles son las diferencias entre sincronizar datos desde endpoints/casos de endpoint?
- ¿Cómo utilizar datos de prueba en Apidog?
- ¿Cómo recuperar datos de prueba en scripts en Apidog?
- ¿Cómo ejecutar escenarios de prueba por lotes en Apidog?
- ¿Cómo programar tareas de prueba en Apidog?
- ¿Cómo ejecutar una prueba de rendimiento en Apidog?
- ¿Cómo puedo ver las peticiones y respuestas reales en las pruebas de rendimiento?
- ¿Cómo puedo exportar informes de pruebas de rendimiento en Apidog?
- ¿Cómo utilizar los resultados de consultas de base de datos como parámetros para realizar peticiones de API en bucle?
- Capturar y validar webhooks de Stripe en ApiDog durante CI/CD
- ¿Cómo resolver el error "Error: unable to verify the first certificate on runner"?
- Error «Not Found» en el contenedor Docker de General Runner.
- ¿Cómo configurar el host del servidor para el General Runner en la versión web de Apidog?
- ¿Por qué el escenario de prueba programado terminó con 0 peticiones?
- ¿Qué debo hacer si no se puede encontrar el parámetro de carga de archivo en Runner o CLI?
- ¿Cómo usar Runner para ejecutar un escenario de prueba con un paso de carga de archivo?
- ¿Cómo resuelvo el error "Error: unable to verify the first certificate on runner"?
- ¿Cómo accedo y busco en los registros del runner para identificar el problema cuando surge un problema con un runner?
- ¿Qué debo hacer si el parámetro del endpoint es un archivo de carga y no se puede encontrar en Runner o CLI?
- ¿Por qué los pasos de prueba no se sincronizan automáticamente cuando cambia el caso de uso de la API?
- ¿Por qué el uso de varios signos de dólar en un documento Markdown provoca que parte del contenido no se muestre correctamente?
- ¿El Runner autoalojado genera un informe de prueba en el servidor después de ejecutar una tarea?
- ¿Puedo añadir pre/postprocesadores unificados a las peticiones en un escenario de prueba?
- ¿Cómo puedo mantener valores dinámicos coherentes durante una única ejecución de prueba automatizada?
- Publicar documentación de API
- ¿Cómo ocultar todos los logotipos de Apidog en los documentos publicados?
- Cuando se actualiza la especificación de la API, ¿cambiará la documentación de la API?
- ¿Cómo compartir APIs con colaboradores en Apidog?
- ¿Cómo personalizar el dominio de la documentación de Apidog?
- ¿Cómo crear documentación multiversión en Apidog?
- Alcance de uso compartido para sitios de documentación publicados en Apidog
- Alcance de uso compartido para la lista Share Doc en Apidog
- ¿Por qué los Share Docs publicados no muestran el hostname?
- ¿Cómo pueden los usuarios de la documentación modificar la URL base en documentos compartidos?
- ¿Puedo duplicar un documento de Apidog publicado para usarlo en mi propio proyecto?
- ¿Cómo compartir encabezados (por ejemplo, token) en la documentación en línea de Apidog?
- ¿Por qué mi miembro del equipo no puede encontrar la documentación publicada?
- ¿Cómo soluciono la expiración de un certificado SSL o un error 526 de Cloudflare en mi dominio personalizado?
- SMTP personalizado configurado correctamente, pero los usuarios en la lista de permitidos no reciben correos electrónicos con OTP
- Markdown
- ¿Cómo usar tarjetas para enlazar a varias páginas o endpoints dentro de Apidog?
- ¿Por qué algunos contenidos no se muestran correctamente al usar varios símbolos $ en documentos Markdown?
- ¿Cómo usar imágenes con fondo transparente en Apidog Markdown?
- ¿Cómo establecer el ancho de columna de una tabla Markdown?
- ¿Cómo puede insertar APIs internas, documentos, esquemas de datos o carpetas en un documento Markdown?
- ¿Cómo agrego un enlace a un documento o endpoint dentro de un proyecto en un componente de tarjeta de Apidog?
- Ramas
- Administración
- ¿Cómo instalar el cliente de Apidog de forma silenciosa?
- ¿Por qué veo un error de «Sin permiso» a pesar de tener acceso de administrador?
- ¿Cómo puedo comprobar el número de versión del runner?
- ¿Apidog es compatible con Windows 7?
- ¿Por qué Apidog muestra el error "Cannot locate program entry point DiscardVirtualMemory in dynamic link library KERNEL32.dll" después de la instalación?
- Cambios de suscripción y reembolsos
- Las peticiones web funcionan, pero la aplicación muestra "read ECONNRESET": ¿por qué?
- ¿Por qué no puedo abrir Apidog después de una actualización del sistema Windows?
- Por qué Apidog no se abre después de una actualización del sistema Windows
- Facturación
- On-premises
- Web y cliente
Compartir documentación de API
Una vez que su API se haya desarrollado y depurado correctamente, Apidog facilita la generación de documentación profesional que puede compartir con su equipo, las partes interesadas o desarrolladores externos.
Guía paso a paso
Siga estos pasos para generar y compartir la documentación de su API:
Paso 1: Acceder al módulo Share Docs
-
Abra su proyecto de Apidog
-
Cambie al módulo Share Docs desde la barra lateral
Paso 2: Crear un nuevo recurso compartido
- Haga clic en el botón New para iniciar un nuevo recurso compartido de documentación
- Esto abrirá el cuadro de diálogo de configuración del recurso compartido
Paso 3: Configurar los ajustes del recurso compartido
Complete los siguientes ajustes en la configuración del recurso compartido:
| Ajuste | Descripción | Acción recomendada |
|---|---|---|
| Name | Asigne a su recurso compartido un nombre descriptivo | Use el nombre del proyecto + la versión (p. ej., "Pet Store API v1.2") |
| Environments | Seleccione qué entornos incluir | Seleccione todos los entornos para obtener una documentación completa |
| Access | Establezca los permisos de visibilidad | Elija el nivel de acceso adecuado para su audiencia |
- Haga clic en Save para crear su recurso compartido
Paso 4: Acceder a su documentación
- Su nuevo recurso compartido aparecerá en la lista de recursos compartidos
- Haga clic en Open para ver su documentación en un navegador web
- La documentación se abrirá en una nueva pestaña con una URL compartible
Paso 5: Explorar las funcionalidades de la documentación
Su documentación incluye funcionalidades potentes:
-
Explorador interactivo de API: Navegue por los endpoints en el árbol de directorios de la izquierda
-
Try It Out: Envíe peticiones en vivo directamente desde la documentación
-
Generación de código: Genere fragmentos de código de petición y código de modelo de datos
-
Cambio de entorno: Pruebe diferentes entornos de API
Personalización avanzada y publicación
Apidog ofrece personalización adicional para su documentación:
| Funcionalidad | Descripción | Caso de uso |
|---|---|---|
| Diseño personalizado | Modifique la estructura y la apariencia de la documentación | Coherencia de marca, optimización de la experiencia de usuario |
| Dominio personalizado | Use su propio nombre de dominio | Presentación profesional, reconocimiento de marca |
| URL personalizadas | Cree URL memorables y significativas | Marketing, uso compartido sencillo, beneficios de SEO |
| Control de acceso | Establezca permisos granulares | Equipos internos, socios externos, acceso público |
INFO
Para obtener información detallada sobre las opciones avanzadas de publicación, consulte la guía Publicar documentación de API.
Obtenga más información sobre cómo diseñar, probar, simular mediante mock y publicar APIs en Apidog.
Modified at 2026-06-09 08:52:14