StatementifyApi Docs - StatementifyApi API Documentation

Welcome to the documentation for the StatementifyApi StatementifyApi API Starter. This project provides a production-ready Node.js API boilerplate that follows the StatementifyApi API Governance Standard.

OpenAPI Specification

The API is fully described by an OpenAPI 3.0Hello StatementifyApi specification. This spec defines all endpoints, request/response formats, and security requirements.

Endpoints Overview

Health Check

  • GET /api/v1/statementify/health
  • Returns a simple status indicating the service is healthy.
  • Response: { "success": true, "data": { "status": "ok" }, "error": null }

Status

  • GET /api/v1/statementify/status
  • Returns system status information, such as uptime.
  • Response: { "success": true, "data": { "uptime": <number> }, "error": null }

Items (Protected)

  • GET /api/v1/statementify/items
  • Returns a list of items. Requires a Bearer JWT token in the Authorization header.
  • 401 Unauthorized if no or invalid token is provided.
  • Response: { "success": true, "data": [ { "id": 1, "name": "Pipe Wrench" }, ... ], "error": null }

API Documentation

  • GET /api/v1/statementify/docs
    Serves the Swagger UI for interactive API exploration.
  • GET /api/v1/statementify/docs/raw
    Returns the raw OpenAPI YAML spec.

Application Structure

See Application Structure for details on how the Express app is set up and how endpoints are implemented.