SAP-samples/cap-service-integration-codejam

Service integration with SAP Cloud Application Programming Model

Description

This repository contains the material for the "Service Consumption with the SAP Cloud Application Programming Model" CodeJam, brought to you by the Developer Advocates at SAP.

Overview

This CodeJam introduces attendees to service integration with the SAP Cloud Application Programming Model (CAP). Specifically, the Node.js flavor of CAP is used.

During this event, you'll become acquainted with how external services can be integrated and consumed from within a CAP project. In working through the exercises you'll also become comfortable with various facilities that CDS offers for declaring, relating and exposing entities, and familiar with how the SAP Cloud SDK covers connectivity and destinations, supporting such integration scenarios with CAP.

Session prerequisites

In order to get the most from this CodeJam, and to be able to work through the exercises, there are certain prerequisites that you must have sorted out before the day of the CodeJam.

The prerequisites are detailed in a separate prerequisites file. Please ensure you have everything ready before attending the CodeJam.

Exercises

These are the exercises, each in their own directory, sometimes with supporting files and scripts. We will work through the exercises in the order shown here. From a session flow perspective, we are taking the "coordinated" approach:

The instructor will set you off on the first exercise, and that's the only one you should do; if you finish before others, there are some questions at the end of the exercise for you to ponder. Do not proceed to the next exercise until the instructor tells you to do so.

The exercises are written in a conversational way; this is so that they have enough context and information to be completed outside the hands-on session itself. To help you navigate and find what you have to actually do next, there are pointers like this 👉 throughout that indicate the things you have to actually do (as opposed to just read for background information).

1. Set up your workspace
2. Explore the basic service
3. Import an OData service definition
4. Understand service mocking
5. Add test data for the mocked external service
6. Mock external service in a separate process
7. Add CDS definitions to integrate services
8. Introduce SAP Cloud SDK
9. Set up the real remote system configuration
10. Run the service with real remote delegation
11. Associate local and remote entities
12. Extend the SAP Fiori elements UI with annotations

Feedback

If you can spare a couple of minutes at the end of the session, please help us improve for next time by providing some feedback.

Simply use this Give Feedback link to create a special "feedback" issue, and follow the instructions in there.

Thank you!

Acknowledgements

The exercise content in this repository is based on previous work for an SAP TechEd 2 hour workshop, written by Christian Georgi of the CAP team.

How to obtain support

Support for the content in this repository is available during the actual time of the CodeJam event for which this content has been designed.

License

Copyright (c) 2023-2026 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.