httpYac HTML Report Action

Run httpYac API tests and generate a beautiful, standalone HTML report — directly in your GitHub Actions workflow.

Powered by httpyac-plugin-reporter-html — the first HTML reporter plugin for httpYac.

---

Features

• Runs all your .http test files via httpYac CLI
• Generates a single standalone HTML report — no external dependencies, works offline
• Full request/response detail per endpoint — headers, body, status, duration
• Assertion badges with actual error messages inline
• 9-stat summary — requests, passed, failed, skipped, duration + test-level totals
• Filter & search — by status class or outcome
• Upload as a workflow artifact and share with your team

---

Usage

Minimal

- uses: AbhilashBiradar/httpyac-html-report-action@v1

Full example

name: API Tests

on: [push, pull_request]

jobs:
  api-tests:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Run httpYac tests and generate HTML report
        uses: AbhilashBiradar/httpyac-html-report-action@v1
        with:
          files: '**/*.http'
          env: dev
          title: 'My API Test Report'
          output: report.html
          fail-on-error: true
        env:
          BASE_URL: ${{ secrets.BASE_URL }}
          API_KEY: ${{ secrets.API_KEY }}

      - name: Upload HTML report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: api-test-report
          path: report.html
          retention-days: 30

With custom working directory

- uses: AbhilashBiradar/httpyac-html-report-action@v1
  with:
    files: 'tests/**/*.http'
    working-directory: './api-tests'
    output: './api-tests/report.html'
    title: 'My API Tests'

---

Inputs

Input	Required	Default	Description
files	No	**/*.http	Glob pattern for .http files
env	No	(none)	httpYac environment name
output	No	report.html	Output HTML file path
title	No	httpYac HTML Report	Title shown in the report header
working-directory	No	.	Directory to run httpYac from
httpyac-version	No	latest	httpYac CLI version to install
fail-on-error	No	true	Fail the step if any assertion fails

---

Outputs

Output	Description
report-path	Path to the generated HTML report file
passed	Number of passed requests
failed	Number of failed requests
total-requests	Total number of HTTP requests executed

---

How it works

1. Installs httpYac CLI globally
2. Installs httpyac-plugin-reporter-html in your working directory
3. httpYac auto-discovers the plugin by naming convention — no config changes needed
4. Runs httpyac send against your .http files
5. Plugin writes report.html after all tests complete

The plugin hooks into httpYac's responseLogging lifecycle — which fires after all @assert blocks run — so the report always reflects the real pass/fail state of every test.

---

Report preview

---

Related

• httpyac-plugin-reporter-html — the npm plugin powering this action
• httpYac — the HTTP testing tool

---

License

MIT © Abhilash Biradar