HTTP REST Server

Context

• request - Express request.
• response - Express response.
• next - Express next function.
• schema - The payload validation schema
• route - The REST route details.
• args - Express route arguments
• params - URL parameters
• payload - The parsed and validated payload.
• token - The header authentication bearer token.
• userToken - The cookies ID token.
• error(payload, [statusCode]) - Returns error response.
• success(payload, [statusCode]) - Returns success response.

Route Schema

See schema.json for JSON schema validation and property description.

{
    "api": {
        "prefix": "",
        "routes": [
            {
                "method": "string",
                "path": "string",
                "schema": "string",
                "event": "string",
                "permission": "string"
            }
            ...
        ]
    },

    "schemas": {
        "$refs": [
            ...
        ]
        ...
    }
}