Primeros pasos con Capydox
Flujo típico desde el registro hasta documentar APIs y evidencias en equipo.
1. Crea tu cuenta
Regístrate con correo y contraseña y confirma el correo cuando recibas el enlace. Si tu empresa usa una organización con SSO, tu administrador puede darte acceso sin contraseña local.
2. Crea o abre un workspace
En el panel de workspaces puedes crear un proyecto personal o entrar en uno de equipo u organización según tu rol. Cada workspace agrupa colecciones, documentación, OpenAPI, evidencias y ajustes propios.
3. Importa tu colección
En APIs → Importar sube colecciones en formatos compatibles (Postman JSON, Insomnia YAML, ApiDog JSON). Run2Doc genera la base técnica (endpoints, métodos, modelos) para documentar y enlazar evidencias.
4. Documenta y revisa
- Documentación Markdown del workspace: visión general del proyecto.
- Documento por colección: edita Markdown por request o vista unificada.
- Editor OpenAPI: mantén un spec YAML/JSON por workspace con validación y vista previa.
5. Evidencias y entornos
Ejecuta o registra pruebas y asocia evidencias a requests. Configura entornos (URLs y variables) para alinear documentación con despliegues reales.
6. Crece con el equipo
Con planes Team u organización, invita miembros, define roles y, en Business, configura SSO OIDC para tu dominio.
Checklist rápido
- Correo verificado.
- Workspace principal definido por equipo.
- Convenciones de nombres de colecciones y versionado acordadas.
- Roles y SSO revisados antes de invitar externos.