🛡️ Sentinel

The Self-Healing API Monitor for Modern Engineering Teams.

Sentinel is an autonomous API synchronization and health-check tool built on the Hoppscotch engine. It bridges the gap between static OpenAPI documentation and living, breathing production environments by "healing" data gaps, generating smart mocks, and executing high-fidelity pulses.

🚀 Key Features

• Self-Healing Sync — Automatically extracts origins and base URLs from specifications, resolving "headless" documentation without manual configuration.
• Smart Mocking — Generates high-fidelity request bodies, including synthetic binary data for multipart/form-data endpoints and complex nested JSON structures.
• Variable-Aware Execution — Seamlessly resolves Hoppscotch-style placeholders (<<baseUrl>>) and path parameters ({{id}}) during runtime.
• Pipeline-First — Designed for CI/CD environments with a clean summary output and a strict health-score mode.

📦 Installation

# Global installation
npm install -g sentinel-api-tool

# Or use directly via npx
npx sentinel-api-tool <command>

🛠️ Commands

sync

Fetches an OpenAPI/Swagger specification and transforms it into a healed Hoppscotch collection.

sentinel sync https://api.yourdomain.com/openapi.json

Healing Logic: If the spec lacks a server URL, Sentinel uses the source origin to populate the collection's base URL.

pulse

Executes an autonomous health check across all endpoints in the synchronized collection.

sentinel pulse

Output: A real-time log of status codes, methods, and response times, followed by a comprehensive Health Score summary table.

📊 Health Score Summary

When running a pulse, Sentinel provides a detailed breakdown:

| Status | Meaning | | ---------------------- | ------------------------------------------------------------------------------ | | ✅ 2xx | Success — Endpoint is healthy and reachable. | | ⚠️ 4xx | Warning — Client error (often indicates a need for specific auth or data). | | ❌ 5xx / ConnFailure | Failure — Server is down or the URL is unreachable. |

🤖 CI/CD Integration

Sentinel is built to be the gatekeeper for your API integrations. Use it in GitHub Actions or GitLab CI:

- name: Run Sentinel Health Check
  run: |
    npx sentinel-api-tool sync ${{ secrets.API_SPEC_URL }}
    npx sentinel-api-tool pulse

🤝 Contributing

Sentinel is an extension of the Hoppscotch ecosystem.

1. Fork the repo.
2. Create your feature branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -m 'Add my feature').
4. Push to the branch (git push origin feature/my-feature).
5. Open a Pull Request.

📄 License

MIT — see LICENSE for details.

Author: [Fantom-01] · Built with Hoppscotch Core