CAP Service SDK for Node.js

Reference Documentation

Conventions — we use the following notations in method signatures:

cds.connect.to (service, options?) → service
cds.serve (service) … ⇢ service
↳ .from (model)
↳ .at (path)

Read them as follows:

param? — appended question marks denote optional parameters

→ result — solid line arrows: returns the given result

⇢ result — dashed arrows: returns a Promise resolving to the given result

... — denotes a fluent API, eventually returning/resolving to given result

↳ — denotes subsequent methods to add options in a fluent API

The cds Facade Object: The cds facade object provides access to all Node.js APIs. It is implemented as a global singleton, with lazy-loading of sub packages to minimize bootstrapping time and memory consumption.
Core Services API: Classes cds.Service, cds.Event, and cds.Request, plus additional factory methods to bootstrap, serve and connect to services, provide the essential APIs to implement and consume services.
Constructing Queries with cds.ql: Use the cds.ql API to construct queries as first-order CQN objects using a fluent, embedded SQL-like API style. These queries are usually passed to services for execution using srv.run.
Application Service Providers: Class cds.ApplicationService is the default service provider implementation, adding generic handlers as introduced in the Cookbook guides on Providing Services, Localized Data and Temporal Data.
Remote Services: Class cds.RemoteService is a service proxy class to consume remote services via different protocols, like OData or plain REST.
Messaging: Class cds.MessagingService and subclasses thereof are technical services representing asynchronous messaging channels. They can be used directly/low-level, or behind the scenes on higher-level service-to-service eventing.
Databases: There’s more to come in this place in upcomming releases…
Protocol Adapters: There’s more to come in this place in upcomming releases…
Authentication: This guide is about authenticating users on incomming HTTP requests.
Best Practices: Learn about Node.js best practices.