Qué pertenece a un proyecto de ejemplo
Mantenga la configuración, las llamadas API, la validación de resultados y la presentación por separado. Proporcione direcciones y credenciales a través de la configuración del entorno y especifique la dependencia y las versiones de tiempo de ejecución. Muestre resultados exitosos y fallidos para que los usuarios puedan evaluar tanto la ejecución como la corrección empresarial.
Si su versión incluye un SDK oficial, siga las instrucciones de instalación y autenticación específicas de la versión. De lo contrario, escriba al cliente contra el contrato API acordado. Confirme los nombres de los paquetes con el proveedor y mantenga las credenciales personales fuera del repositorio.
Comience con un ejemplo sintético completamente local
El siguiente ejemplo de biblioteca estándar de Python filtra por estado y luego suma el total de las filas seleccionadas. Se ejecuta localmente sin llamar a Haomai Technology AI Brain ni conectarse a una base de datos. Úselo como punto de partida para probar una definición de métrica. El total esperado es 200.00.
from decimal import Decimal
# Synthetic records for a local calculation. No SDK call is made.
orders = [
{"region": "A", "status": "confirmed", "amount": "120.00"},
{"region": "B", "status": "confirmed", "amount": "80.00"},
{"region": "A", "status": "cancelled", "amount": "30.00"},
]
total = sum(
(Decimal(row["amount"]) for row in orders
if row["status"] == "confirmed"),
Decimal("0.00"),
)
assert total == Decimal("200.00")
print(total)Agregar la llamada de servicio
- Mantenga los datos de referencia locales y el resultado esperado para que el cálculo pueda realizarse de forma independiente.
- Implemente la llamada de acuerdo con el contrato real y configure tiempos de espera y cancelación en el entorno de prueba.
- Convierta los valores devueltos a una estructura de datos explícita que distinga los resultados completos, fallidos y parciales.
- Verifique que los registros omitan credenciales, preguntas privadas completas y detalles innecesarios a nivel de registro.
Incluir casos de falla en el ejemplo
Cubra resultados vacíos, discrepancias de tipos, campos desconocidos, tiempos de espera y permisos insuficientes como mínimo. Ofrezca a los usuarios un siguiente paso de diagnóstico junto con el error. Vuelva a ejecutar estos casos después de las actualizaciones de dependencia o servicio para identificar qué capa cambió.
Incluya casos límite para montos, valores faltantes y campos de estado. Distinguir un valor faltante de un cero numérico. Llenar automáticamente los espacios en blanco en la pantalla puede ocultar un problema de calidad de los datos o un cambio de protocolo.
