Exercise: Implementing CRUD Operations in a TypeScript NestJS Application

Objectives

After completing this lesson, you will be able to:

  • Implementing CRUD operations in a TypeScript NestJS application

Implementing CRUD operations in a TypeScript NestJS application

In this exercise, you will learn how to implement CRUD operations in SAP Cloud SDK application. We will use the Mock Server instead of the actual SAP S/4HANA Cloud.

Prerequisites

For the complete execution of current exercise, you must execute the following activities first, using SAP Business Application Studio:

  1. Execute the following exercises:
    • Creating your free trial account in SAP BTP
    • Setting up the mock server, so that you have the Mock server program available in the cloud-s4-sdk-book folder.
  2. Run the following commands in a terminal, in case you didn't do it already in previous exercises, to clone the Git repository for the course:
    Code snippet
    cd ~/projects
    git clone https://github.com/SAP-samples/cloud-sdk-learning-journey.git
    Expand
  3. Choose FileOpen Folder and open the /home/user/projects/cloud-sdk-learning-journey/ folder.

Steps

  1. Checkout the branch tsnestjs_v3.0_crud in SAP Business Application Studio

    1. Open SAP Business Application Studio.

    2. Run the following commands in the terminal.

      Code snippet
      cd ~/projects/cloud-sdk-learning-journey
      git checkout -f tsnestjs_v3.0_crud
      Expand
  2. Build and run the project.

    1. Run the application by executing the following commands in the terminal

      Code snippet
      cd cloudsdk_bp_ts
      npm i
      npm run start:dev
      Expand
  3. Query the Business Partner API of SAP S/4HANA Cloud

    1. Open the requests.http file in the cloudsdk_bp_ts folder

    2. Click on Send Request in the requests.http file to submit the GET request for business partners

    3. Verify that the list of business partners are returned from the Mock Server. Note: If the Mock Server is not running, make sure to run the Mock Server on port 8081 by following the prerequisites at the top

    4. Click on the various Send Request in the requests.http file to submit GET, PUT, POST requests

    5. Verify that the response is correct for all the requests

    6. Stop the running application using Ctrl + C in the corresponding terminal window.

  4. Optional: code walk-through.

    1. Review code in the following source files:

      File nameComments on code changes
      business-partner.controller.ts

      Code logic is as follows...

      1. Annotate the class BusinessPartnerController with @Controller to mark it as a Controller class
      2. Create 5 methods getBusinessPartners, getBusinessPartnerById, createAddress, updateBusinessPartnerAddress, deleteBusinessPartnerAddress to handle the GET, GET/{id}, POST, PUT, DELETE requests
      3. Annotate each method with the respective @Get(), @Get('/:id'), @Post('/:businessPartnerId/address'), @Put('/:businessPartnerId/address/:addressId'), @Delete('/:businessPartnerId/address/:addressId') respectively
      4. Create an instance of the BusinessPartnerService class to handle each of the method implementation by passing in the required values
      business-partner.service.ts

      Code logic is as follows...

      1. Implement logic for each of the methods in the Controller class
      2. Use the SAP Cloud SDK fluent API method chaining to provide additional parameters
      requests.httpProvides various HTTP requests that can be submitted to query the Business Partner API
      commands.txtProvides various commands that can be run on the terminal
      Note
      Check out the SAP Cloud SDK documentation on Building an Address Manager Application with SAP Cloud SDK. https://sap.github.io/cloud-sdk/docs/js/tutorials/address-manager/change

Log in to track your progress & complete quizzes