SAP Cloud SDK for JavaScript Logo
build REUSE status Fosstars security rating
SAP Cloud SDK
An SDK to reduce your development effort when building side-by-side extension applications on SAP Business Technology Platform that integrate with SAP solutions and services such as SAP S/4HANA, SAP SuccessFactors, and many others.
Announcement - Upgrade Strategy
We have released version 4 of the SAP Cloud SDK for JavaScript on npm. Check out the upgrade guide for detailed instructions. The upgrade effort should be less than 1 day for an average project and should not take more than a week for larger projects.
It is recommended to upgrade to version 4 as version 3.x will not be actively maintained, with the exception of critical security vulnerabilities for up to 3 months.
Please share your ideas, suggestions or improvements in our GitHub discussion.
Looking for documentation?
Check our API documentation and getting started guide on our documentation portal.
Table of Contents
- Announcement - Upgrade Strategy
- Looking for documentation?
- Table of Contents
- Packages
- @sap-cloud-sdk/http-client
- @sap-cloud-sdk/connectivity
- @sap-cloud-sdk/odata-v2
- @sap-cloud-sdk/generator
- @sap-cloud-sdk/test-util
- How to switch to the Open Source version of the SAP Cloud SDK
- Related Projects
- SAP Cloud SDK Sample Projects
- Feedback
- Contribute
- Links
- License
Packages
This project publishes multiple packages and is managed using turborepo.
@sap-cloud-sdk/http-client
This package contains the generic http-client functionality with built-in connectivity with executeHttpRequest(). The generic http-client adds SAP infrastructure specific functionality on top of a standard HTTP Client.
To install the SAP Cloud SDK http-client in your project, run:
$ npm install @sap-cloud-sdk/http-client
@sap-cloud-sdk/connectivity
This package contains all Cloud Foundry connectivity service related methods like getDestination() and registerDestination().
To install the SAP Cloud SDK conectivity in your project, run:
$ npm install @sap-cloud-sdk/connectivity
@sap-cloud-sdk/odata-v2
This package contains all OData version 2 specific functionality, like the request builders for create/update operations, predefined filter functions, batch. Package @sap-cloud-sdk/odata-v4 contains the same functionality for OData verison 4.
To install the SAP Cloud SDK odata-v2 in your project, run:
$ npm install @sap-cloud-sdk/odata-v2
Similarly, to install the SAP Cloud SDK odata-v4, use:
$ npm install @sap-cloud-sdk/odata-v4
@sap-cloud-sdk/generator
The 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/generator
@sap-cloud-sdk/test-util
The test-util package makes writing tests for your SAP Business Technology 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-util
How to switch to the Open Source version of the SAP Cloud SDK
Please 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.
Related Projects
SAP Cloud SDK Sample Projects
We have created multiple sample projects which showcase the use of the SAP Cloud SDK for TypeScript/JavaScript in different scenarios. Each project outlines the configurations needed to execute it locally and to deploy the project to SAP Business Technology Platform.
Feedback
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.
Contribute
Want to contribute? Check out our contribution guide and follow our code of conduct.
Links
- Official support channel
- GitHub
- SAP Cloud SDK Documentation
- Overview
- Getting started guide
- API documentation
- Release notes
- Sample repository
- SAP Cloud SDK for AI (JavaScript)
- GitHub
- Documentation
License
This project is licensed under the terms of the Apache 2.0 license as noted in the license file.
This project depends on libraries licensed under the SAP Developer license agreement. This limits the use of those dependencies to development purposes only.