CDS Design Time APIs

This guide is about programmatic CDS design-time APIs.

Install @sap/cds-dk

The design-time APIs are provided with package @sap/cds-dk which needs to be installed locally in your project:

npm add @sap/cds-dk --save-dev

That given, you can use the APIs in your project like this:

const cds = require('@sap/cds-dk')
cds.import(...)

Don't load cds-dk code at runtime

Note that @sap/cds-dk is a design-time dependency that runs locally or in continuous integration (CI) pipelines. Avoid loading the previously shown code at application runtime in deployed applications.

cds. add()

Learn how to create a cds add plugin.

cds. import()

Programmatically use cds.import.

cds. build()

The guide provides an overview of custom build processes for CAP projects, explaining how to tailor the standard build process to specific project requirements.