An SDK to reduce your development effort when building side-by-side extension applications on SAP Cloud Platform that integrate with SAP solutions and services such as SAP S/4HANA, SAP SuccessFactors, and many others.
Check our API documentation and getting started guide on our documentation portal.
- Packages
- How to switch to the Open Source version of the SAP Cloud SDK
- Related Projects
- Feedback
- Contribute
- Links
- License
This project publishes multiple packages and is managed using lerna. To use the SDK in your project, we recommend using our commandline interface.
The core is the heart of the SAP Cloud SDK and contains the functionality that is essential to every project powered by the SDK. Any OData client built by the SAP Cloud SDK, be it the VDM or clients built by the generator are using the core. We recommend to install this in addition to your clients.
To install the SAP Cloud SDK core in your project, run:
$ npm install @sap-cloud-sdk/coreThe SAP Cloud SDK generator is a command line interface (CLI) that allows you to create clients for your own OData services or other SAP systems besides SAP S/4HANA based on their service specifications.
To install the SAP Cloud SDK generator in your project, run:
$ npm install @sap-cloud-sdk/generatorThe test-util package makes writing tests for your SAP Cloud Platform application more convenient.
To install the SAP Cloud SDK test-util as development dependencies in your project, run:
$ npm install -D @sap-cloud-sdk/test-utilPlease ignore this section, if you have never used the SAP Cloud SDK with a version < 1.18.0.
If you are using an old version of the SAP Cloud SDK, you might want to read how to migrate to this Open Source version of the SAP Cloud SDK.
To reduce the development effort even more, you can use the SAP Cloud SDK command line interface (CLI) to start a new NestJS project, including the SDK right from the get go and supporting you do deploy your project to SAP Cloud Platform.
In addition to the Open Source parts of this project, we also publish the SAP Cloud SDK Virtual Data Model (VDM) - JavaScript / TypeScript clients for the latest versions of the whitelisted OData services of SAP S/4HANA Cloud under the SAP Developer license. Those are not included in this project, but rely on modules from this project.
To install an OData client for an SAP S/4HANA service run:
$ npm install @sap/cloud-sdk-vdm-<service name>-serviceIn the example above, service name is the name of the service you want to use, e. g. for the business partner service, run: npm install @sap/cloud-sdk-vdm-business-partner-service.
Continuous delivery is a method to develop software with short feedback cycles. It is applicable to projects both for SAP Cloud Platform and SAP on-premise platforms. SAP implements tooling for continuous delivery in the open-source project "Piper". The goal of project "Piper" is to substantially ease setting up continuous delivery in your project using SAP technologies.
Part of project "Piper" is the SAP Cloud SDK Pipeline which is tailor-made to deliver high-quality applications on SAP Cloud Platform using the SAP Cloud SDK for Java and for JavaScript.
Feel free to leave your feedback in form of GitHub issues for bugs and feature requests. If you have broader questions, we are active on StackOverflow too.
Want to contribute? Check out our contributing guide.