Access the reference documentation
The reference documentation of SAP Cloud SDK can be accessed via the following steps:
- Open: https://sap.github.io/cloud-sdk
- Choose Get started with the SDK for JavaScript.
The Core Libraries
The SDK consists of a few core libraries and a number of API-specific pregenerated libraries.
The core libraries are:
- @sap-cloud-sdk/connectivity: The connectivity library provides functionality to read and exchange with services like the destination, XSUAA and connectivity service. It provides the basic types needed to reflect the concept of a destination throughout the SAP Cloud SDK for JavaScript.
- @sap-cloud-sdk/http-client: The HTTP client library is a thin HTTP client, that allows you to execute requests by leveraging the concept of destinations. You can flexibly configure a request to your needs and send arbitrary HTTP requests to the given destination.
- @sap-cloud-sdk/odata-v2, @sap-cloud-sdk/odata-v4, and @sap-cloud-sdk/openapi: The OData v2, v4, and OpenAPI libraries build the foundation for client libraries (custom and pregenerated). They contain OData and OpenAPI specific abstractions, that the client libraries use to expose their APIs.
- @sap-cloud-sdk/generator and @sap-cloud-sdk/openapi-generator: The OData and OpenAPI generators are CLIs that generate client libraries based on the services' specifications (either EDMX format or OpenAPI/Swagger). You can use them to generate your own clients. The pregenerated client libraries are generated using these generators.
Generating an OData Client
The OData client generator allows you to generate custom OData client libraries for OData services. You can then access these services from your code using the client libraries. For details how to generate your libraries, see the standard documentation at Generate an OData client for JavaScript.
Using the client libraries to consume the SAP APIs
Information about the way to use the client libraries to interact with the SAP APIs is described in the following pages of the standard documentation: