Quan treballes amb httpYac al teu pipeline d'integració contínua, tot funciona sobre rodes: les proves passen, l'equip ho sap, però tan bon punt algú demana 'podem veure un informe?', t'adones que mirar la sortida del terminal no és suficient. Aquí entra en joc httpyac-plugin-reporter-html, una eina que transforma els resultats de les teves proves en un informe HTML complet, autònom i sense dependències externes.
Si encara no coneixes httpYac, imagina't com el germà de línia d'ordres de l'extensió REST Client de VS Code. Escrius les teves crides API en fitxers .http — mètode, URL, capçaleres, cos, assertions — i les executes des del terminal o als teus pipelines de CI/CD. És ràpid, scriptable i s'integra perfectament amb qualsevol flux de treball. Però li faltava una peça: un informe llegible i compartible.
Aquesta peça és httpyac-plugin-reporter-html. Aquest plugin es connecta al cicle de vida d'httpYac i genera un únic fitxer HTML independent després que les teves proves finalitzin. Obre'l a qualsevol navegador — sense servidor, sense internet, sense dependències. Tot — CSS, JavaScript, dades de prova — està incrustat al mateix fitxer.
La instal·lació és immediata: npm install --save-dev httpyac-plugin-reporter-html. httpYac descobreix automàticament el plugin, sense configuració extra. Després executes les teves proves amb httpyac send **/*.http i el fitxer report.html apareix a l'arrel del teu projecte. Si necessites personalitzar el títol o la ruta de sortida, pots afegir un bloc htmlReporter al teu .httpyac.config.js.
Què mostra realment l'informe? No és un simple mur de marques verdes. Cada regió de prova obté una targeta amb tot el necessari: una barra d'heroi amb 9 estadístiques — peticions, passades, fallides, omeses, durada més totals a nivell de prova — targetes amb codi de color (verd per 2xx, ambre per 3xx, taronja per 4xx, vermell per 5xx), panells plegables per a capçaleres i cossos de petició i resposta (amb JSON formatejat), insignies d'asserció que mostren el missatge d'error quan fallen, metadades per petició (fitxer font, línia, timestamp, títols i descripcions del teu fitxer .http), i un filtre de cerca al costat del client que permet filtrar per resultat o classe d'estat HTTP, sense recarregar la pàgina. Les regions no HTTP (AMQP, MQTT, gRPC, WebSocket) s'ometen automàticament, mantenint l'informe centrat en les peticions HTTP.
Darrere l'escenari, el plugin s'enganxa a l'esdeveniment responseLogging del cicle de vida d'httpYac, no a onResponse. Aquesta distinció és crucial: onResponse es dispara just després de rebre la resposta HTTP, abans que s'executin les assertions. Si recollíssim resultats allà, obtindríem dades de prova buides. responseLogging es dispara després que el bucle d'execució complet hagi acabat, incloent totes les assertions. Per aleshores, cada asserció ha estat avaluada i l'estat complet (SUCCESS, FAILED, ERROR, SKIPPED) està disponible a la regió. A més, l'informe s'escriu progressivament després de cada petició, de manera que fins i tot si una execució s'interromp a mig camí, obtens un informe parcial amb el que s'hagi completat.
Aquest enfocament és ideal per a entorns d'integració contínua. Per exemple, a GitHub Actions pots pujar l'informe com a artifact, fins i tot si les proves fallen, utilitzant if: always(). Així tot l'equip pot descarregar l'HTML i revisar els resultats sense dependre d'una infraestructura externa.
A Q2BSTUDIO, com a empresa especialitzada en desenvolupament d'aplicacions a mida, sabem que la qualitat del software es sosté sobre proves automatitzades sòlides. Per això incorporem eines com httpYac i el seu plugin d'informes als nostres fluxos de treball. Els nostres clients que migren a cloud AWS/Azure sovint necessiten informes compartibles que no requereixin infraestructura addicional, i aquest plugin encaixa perfectament. A més, en projectes on integrem IA, ciberseguretat o BI/Power BI, disposar d'un informe clar de les proves d'API accelera la detecció de regressions i millora la col·laboració entre equips tècnics i de negoci.
La simplicitat del plugin no li resta potència. Amb opcions de configuració com el títol de l'informe i la ruta de sortida, s'adapta a qualsevol projecte. I si necessites funcionalitats addicionals — exportació a JSON, múltiples formats de sortida, integració amb Slack — el projecte està obert a contribucions a GitHub.
En definitiva, httpyac-plugin-reporter-html resol un problema real: com compartir resultats de proves d'API de manera elegant, sense dependre de serveis externs i amb una experiència d'usuari que qualsevol membre de l'equip pot apreciar. Dóna-li una oportunitat, prova'l al teu pipeline i descobreix com un informe ben dissenyat pot millorar la comunicació al teu equip de desenvolupament.
