@sap/odata-server v1.8.3

OData V4.0 Server Library

Library is deprecated and will not be further developed and maintained. We recommend to use the SAP Cloud application programming model to build OData Services instead of the library.

Table of Contents

• Overview
• Installation
• Usage
• Supported Requests
• Releases and Milestones

Overview

With the OData server library OData V4.0 services can be implemented based on the OASIS OData standard. The library can be directly used to build OData services and is also part of the SAP Fiori programming model as well the SAP Cloud Platform programming model, where the data model can be defined in CDS (Core data services) and the OData service be generated out of the model.

The library leaves the freedom to build OData services with any database or persistence layer. It is also possible to create services that are calling external REST/OData services and mix up the data with your application data.

The library is modular and consists of the following main components:

• EntityDataModel - Define your EDM in JSON format. Our provider creates the EDM out of your model and caches EDM model elements
• Handler Dispatcher - Maps requests to handler functions for CRUD operations
• URI parsers - Parse the request URI including the OData system query options (like $format, $select, $expand, ...) and validates each URI segment against the EDM model and the OData ABNF
• Serializers and Deserializers for the request and response payload. The deserializers validate the request payload and support type mapping between OData EDM types and JavaScript Types
• Automatic OData Reponse generation based on provided data
• ServiceFactory to create the OData service along with the CRUD handler registration
• Conditional request handling for optimistic concurrency control via ETags
• Batch handling - Batch request parsing, dispatching to single batch requests, Content-ID referencing and batch response generation
• Flexible API to support all backends - The service developer has the free choice of his backend system (e.g., databases, frameworks, calling additional external OData services).

Installation

npm install @sap/odata-server

Usage

Load the library:

const odata = require('@sap/odata-server');

Load your EDM model:

const edmModel = require('./<your_edm_model>.json');

Create the service, set the base path, and register request handlers for CRUD operations:

const service = odata.ServiceFactory.createService(edmModel)
    .setBasePath('/serviceroot.svc/')
    .on('create', function create(request, response, next) {...})
    .on('update', function update(request, response, next) {...})
    .on('delete', function delete(request, response, next) {...})
    .on('read', function read(request, response, next) {...});

You can create an HTTP server locally to test your service:

const http = require('http');
const port = 9000;
const server = http.createServer((req, res) => service.process(req, res))
    .listen(port,
        () => console.log('Server listens on port ' + port + ' - '
            + 'Service URL: http://localhost:' + port + '/serviceroot.svc/'));

Supported Requests

Read Requests Using HTTP GET

Create/Insert Requests Using HTTP POST

Update Requests Using HTTP PUT/PATCH

Delete Requests Using HTTP DELETE

Functions Using HTTP GET

Actions Using HTTP POST

Supported System Query Options

Analytical Queries

Analytical queries with $apply are described in the specification for the OData data aggregration extension.

Releases and Milestones

Changelog