Backend Architecture¶
The backend is a Node.js/Express TypeScript API. It sits between the React frontend and two external services: TriplyDB (SPARQL knowledge graph) and Operaton (DMN execution engine). Its responsibilities are SPARQL querying, DMN chain orchestration, variable mapping between chain steps, and proxying dynamic TriplyDB endpoint calls.
API versioning¶
All endpoints follow /v1/*. Legacy /api/* endpoints exist with Deprecation response headers for backward compatibility. The version is included in every response via the API-Version header, following Dutch Government API Design Rules API-20 and API-57.
Endpoints¶
Health¶
Returns service health including TriplyDB and Operaton latency checks. Used by CI/CD pipelines and the frontend status indicator.
{
"name": "Linked Data Explorer Backend",
"version": "0.4.0",
"environment": "production",
"status": "healthy",
"uptime": 3600,
"services": {
"triplydb": { "status": "up", "latency": 145 },
"operaton": { "status": "up", "latency": 98 }
}
}
DMN discovery¶
Queries TriplyDB for all cprmv:DecisionModel resources at the given endpoint. Returns models with full variable lists and governance/vendor metadata. Cached per endpoint for 5 minutes.
Returns full metadata for a single DMN by its dct:identifier value.
Returns all chain links including both exact identifier matches and semantic skos:exactMatch matches. Each link includes a matchType field: "exact", "semantic", or "both".
Returns all variable pairs from different DMNs that share a skos:exactMatch concept URI.
Returns circular dependencies detected via semantic links (3-hop traversal).
Chain discovery¶
Returns all DMN pairs where an output variable of one model matches an input variable of another by exact identifier.
Chain execution¶
Request body:
{
"chain": ["SVB_LeeftijdsInformatie", "SZW_BijstandsnormInformatie"],
"inputs": { "geboortedatum": "1960-01-01" },
"endpoint": "https://api.open-regels.triply.cc/..."
}
Executes the chain sequentially, flattening outputs into inputs between steps. Returns per-step results and combined final output.
Convenience endpoint for the fixed three-step Heusdenpas chain with production test data. Target execution time: <1000ms. See API Reference for the full request/response.
Generates a DRD XML file from a chain and deploys it to Operaton. See DRD Generation.
TriplyDB proxy¶
Request body:
{
"endpoint": "https://api.open-regels.triply.cc/...",
"query": "SELECT ?s ?p ?o WHERE { ?s ?p ?o } LIMIT 5"
}
Proxies a SPARQL query to any TriplyDB endpoint, bypassing CORS restrictions. Used by the frontend Query Editor for dynamic endpoint support.
SPARQL service¶
sparql.service.ts builds and executes all SPARQL queries against TriplyDB. Key functions:
findAllDmns(endpoint: string): Promise<DmnModel[]>
findEnhancedChainLinks(endpoint: string): Promise<EnhancedChainLink[]>
findSemanticEquivalences(endpoint: string): Promise<SemanticEquivalence[]>
The findEnhancedChainLinks query uses a BIND(IF(...)) pattern to categorise each link as exact, semantic, or both, then expands both entries into two separate records post-query. This is the mechanism described in Enhanced Validation.
Orchestration service¶
orchestration.service.ts executes sequential chains:
- Fetch DMN metadata for each step from the SPARQL service (cached)
- For the first step, use the user-supplied inputs
- For each subsequent step, build inputs by:
- Flattening all previous step outputs into a single map
- For semantic matches: rename output variable keys to match the expected input identifiers
- Merge with any additional user-supplied inputs
- Call
operaton.service.tsfor each step - Accumulate results
Variable flattening means a semantic chain like heeftJuisteLeeftijd → leeftijd_requirement is transparently bridged — the output value is passed under the input's expected key.
Operaton service¶
operaton.service.ts calls the Operaton REST API:
Request payload maps to Operaton's variable format:
For DRD execution, the same endpoint is used with the DRD entry-point identifier. Operaton handles internal decision dependency evaluation.
Logging¶
Winston structured logging with JSON output. All service calls log at [INFO] level with context (endpoint, query length, result count, latency). Errors log at [ERROR] with stack traces. Log level is configurable via LOG_LEVEL environment variable.
Error handling¶
A central errorHandler.ts middleware catches unhandled errors and returns standardised JSON error responses with appropriate HTTP status codes. SPARQL and Operaton errors are wrapped with descriptive messages before being returned to the frontend. No sensitive data is included in error responses.
Performance¶
Targets:
| Operation | Target |
|---|---|
| Chain execution | < 1000ms |
| Health check response | < 100ms |
| DMN list query | < 500ms |
| API response time (p95) | < 200ms |
Production baselines (Heusdenpas chain, 3 DMNs):
| Measurement | Observed |
|---|---|
| Full chain execution | ~827ms |
| Health check (incl. TriplyDB + Operaton) | ~180ms |
| DMN discovery (SPARQL + parsing) | ~350ms |
| TriplyDB round-trip latency | 150–200ms |
| Operaton per-DMN execution | 80–120ms |
Security¶
HTTP headers — Helmet is configured to set comprehensive security headers on all responses, including Content-Security-Policy, X-Content-Type-Options, X-Frame-Options, and Strict-Transport-Security.
CORS — only origins listed in CORS_ORIGIN are permitted. In production this is restricted to https://linkeddata.open-regels.nl and https://cpsv.open-regels.nl. All other origins receive a CORS rejection.
Input validation — type checking is applied to all request inputs. Variable names, DMN identifiers, and SPARQL endpoint URLs are validated before any service call is made. Request body size is limited to 10 MB.
Environment variables — all sensitive configuration (TriplyDB endpoint URLs, Operaton API URLs, CORS origins) is stored in environment variables and never hardcoded. No secrets are written to logs.
Error responses — the central error handler scrubs stack traces and internal context before returning responses to clients, ensuring no implementation details are exposed.
Dutch Government API Design Rules compliance¶
The API follows the Dutch Government API Design Rules for interoperability and standardisation.
Implemented rules:
| Rule | Description | Implementation |
|---|---|---|
| API-20 | Major version in URI | /v1/* endpoints |
| API-57 | Version header in responses | API-Version: 0.4.0 on every response |
| API-05 | Use nouns for resources | dmns, chains, health |
| API-54 | Plural/singular naming | Correct usage throughout |
| API-48 | No trailing slashes | Enforced in routing |
| API-53 | Hide implementation details | Clean service abstractions |
Language note (API-04) — technical endpoint names (health, version) follow international convention in English. Business resource names (dmns, chains) follow the source data. Dutch variable names (e.g., geboortedatum) are preserved as-is from the DMN definitions.
Planned:
| Rule | Description | Target version |
|---|---|---|
| API-16, API-51 | OpenAPI 3.0 spec at /v1/openapi.json |
v0.5.0 |
| API-02 | Standard error response format | v0.5.0 |
| API-10 | Resource collections with pagination | v1.0.0 |