Skip to content

Latest commit

 

History

History
89 lines (58 loc) · 4.89 KB

README.md

File metadata and controls

89 lines (58 loc) · 4.89 KB
Raw

SAP Cloud SDK for Java Logo

build REUSE status Fosstars security rating Maven Central

SAP Cloud SDK for Java

Contents

  1. About This Project
  2. Features
    1. OData
    2. OpenAPI
    3. Connectivity
  3. Licensing
  4. Support, Feedback, Contributing
  5. Code of Conduct
  6. Building the Project

About This Project

The SAP Cloud SDK for Java makes it easy to build highly connected, resilient, multi tenant SaaS applications on the SAP Business Technology Platform (SAP BTP). It enables you to perform outbound requests using various protocols while only writing the business logic.

For more information head over to the official SAP Cloud SDK for Java Documentation. To get started using the SAP Cloud SDK for Java, please refer to the Getting Started Guide.

Features

OData

The SAP Cloud SDK for Java supports OData v2 and OData v4 protocols by offering Type-Safe and Generic OData Clients and the OData Code Generator.

Popular use cases include:

  • Extending an SAP product or service, building a middle-ware, publishing a cloud app
  • Developing and publishing an OData service
  • Coding convenience and inter-operability

See the OData section of our documentation for more information.

OpenAPI

We make the consumption of OpenAPI services easy and convenient by providing a code generator that converts OpenAPI specifications into type-safe Java client libraries that work within the SAP Business Technology Platform.

Learn more in the OpenAPI section of our documentation.

Connectivity

The Destination API provides convenient abstraction for establishing connections to other systems and services with various authentication methods.

Popular use cases include:

  • Access destinations defined in the SAP BTP Cockpit
  • Define and configure your own destinations
  • Perform REST, RFC, or SOAP requests
  • Use ready-made HTTP Clients to execute custom requests

Please refer to the Connectivity section of our documentation for details.

Licensing

Copyright 2024 SAP SE or an SAP affiliate company and cloud-sdk-java contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Building the Project

Prerequisites:

  • A Java 17 JDK (for example SapMachine).
    • Higher JDK versions currently may produce warnings during compilation which the project is configured to fail on.
  • Maven in version 3.9.5 or higher.

Build, test, and install into local Maven repository:

mvn clean install

Further options:

  • To skip tests, add -DskipTests.
  • To skip formatting, add -DskipFormatting.

To configure code style, formatting and linting for IntelliJ IDEA, follow these instructions.