Prácticas recomendadas para el prompt del SDK del cliente de API

Genera el cliente de bajo nivel a partir de un spec de OpenAPI, y escribe a mano solo una capa delgada e idiomática encima. Confianza: 0.85 Trata el spec de la API como la fuente de verdad y falla el CI cuando el código generado está desactualizado. Confianza: 0.85 Haz posible la primera llamada en tres líneas: instalar, crear un cliente con una clave de API, llamar a un método. Confianza: 0.90 Lee la clave de API de una variable de entorno bien conocida por defecto, y nunca la registres ni la incluyas en mensajes de error. Confianza: 0.95 Expón modelos de solicitud y respuesta completamente tipados, con tipos de TypeScript o sugerencias de tipo de Python incluidos en el paquete. Confianza: 0.90 Devuelve errores tipados con el estado HTTP, el código de error, el mensaje y el ID de solicitud, en lugar de una excepción genérica. Confianza: 0.90 Reintenta solicitudes idempotentes en tiempos de espera, respuestas 429 y 5xx con retroceso exponencial y jitter, y respeta los encabezados Retry-After. Confianza: 0.90 Envía una clave de idempotencia automáticamente en solicitudes POST reintentadas cuando la API lo soporta. Confianza: 0.80 Establece tiempos de espera predeterminados sensatos y permite que los llamadores anulen la configuración de tiempo de espera y reintentos por cliente y por solicitud. Confianza: 0.85 Proporciona iteradores de paginación automática para que los usuarios puedan recorrer todos los resultados sin manejar cursores ellos mismos. Confianza: 0.85 Soporta respuestas de transmisión con iteradores asíncronos nativos o generadores en lugar de callbacks. Confianza: 0.80 Ofrece clientes síncronos y asíncronos en idiomas donde ambos son comunes, compartiendo los mismos modelos. Confianza: 0.75 Mantén las dependencias de tiempo de ejecución mínimas y evita fijar a los usuarios a una versión específica de la biblioteca HTTP. Confianza: 0.85 Envía un encabezado User-Agent con el nombre del SDK, la versión y el tiempo de ejecución para que los propietarios de la API puedan ver la adopción y depurar problemas. Confianza: 0.80 Sigue el versionado semántico estrictamente y documenta los cambios importantes con ejemplos de migración en el changelog. Confianza: 0.90 Nunca elimines un método en una versión menor; primero deprécalo con una advertencia. Confianza: 0.85 Prueba contra fixtures HTTP grabados para velocidad y ejecuta un conjunto más pequeño contra un sandbox real todas las noches. Confianza: 0.80 Ejecuta la suite de pruebas en cada versión de tiempo de ejecución soportada en CI, como cada LTS activo de Node.js o versión de Python. Confianza: 0.85 Pon ejemplos de código ejecutables en el README y la documentación, y prueba esos ejemplos en CI para que nunca se vuelvan obsoletos. Confianza: 0.80 Expón hooks o middleware para registro, trazado y encabezados personalizados en lugar de agregar opciones únicas para cada necesidad. Confianza: 0.75 Permite una URL base personalizada y un cliente HTTP para que los usuarios puedan apuntar el SDK a proxies, mocks o endpoints regionales. Confianza: 0.80 Publica paquetes desde CI con procedencia y lanzamientos firmados, nunca desde el portátil de un mantenedor. Confianza: 0.75