Documentación y conectividad: Mejorando el ecosistema de AutoPic
Recientemente hemos estado trabajando en el proyecto AutoPic, enfocándonos en robustecer su capa de documentación y abrir nuevas vías de integración para los desarrolladores. El objetivo principal ha sido mejorar la accesibilidad de nuestra API y facilitar su uso en herramientas de automatización.
Documentación con Mintlify y OpenAPI
Para ofrecer una experiencia de usuario superior, hemos integrado Mintlify como nuestra plataforma oficial de documentación. Esto nos permite mantener guías actualizadas en español, cubriendo desde el inicio rápido con cURL hasta detalles sobre autenticación.
La referencia de la API ahora se genera automáticamente a partir de nuestra especificación OpenAPI 3.0. Para mantener la sincronización, hemos implementado un script sencillo en Shell que permite actualizar la especificación desde el entorno de despliegue:
# Script para sincronizar spec de OpenAPI
curl -X GET https://api.example.com/openapi.json > api-reference/openapi.json
echo "Sincronización completada con éxito"
Integración como servidor MCP
Además de la documentación web, hemos habilitado un servidor MCP (Model Context Protocol) desarrollado en JavaScript. Esto permite que los asistentes de IA, como Claude Desktop, interactúen directamente con los recursos de AutoPic. Hemos expuesto herramientas clave para gestionar el ciclo de vida de los vehículos:
// Ejemplo simplificado de definición de herramientas para MCP
const tools = [
{ name: "list_vehicles", description: "Obtiene lista de vehículos" },
{ name: "create_vehicle", description: "Registra un nuevo vehículo" },
{ name: "upload_document", description: "Sube documentación técnica" }
];
Esta arquitectura permite que cualquier cliente compatible con el protocolo MCP pueda consumir nuestra REST API de manera nativa, facilitando flujos de trabajo automatizados sin necesidad de escribir código manual adicional. Seguimos utilizando Swagger como una alternativa interactiva para pruebas rápidas y validación de endpoints, complementando así nuestra estrategia de documentación técnica.
