Skip to content

Latest commit

 

History

History
140 lines (96 loc) · 4.58 KB

README.md

File metadata and controls

140 lines (96 loc) · 4.58 KB
Raw

Getting Started

Welcome to a small SAP CAP demo (@sap/cds).

This repo https://t.co/ZVjhFXpCou showcases the rendering of JSON diagrams with PlantUML.

The demo renders a SVG from given JSON string using plantuml.jar executed via command line.

It contains these folders and files, following our recommended project layout:

The app is created with CDS init and follows the best practise

File or Folder Purpose
app/ content for UI frontends goes here
db/ your domain models and data go here
srv/ your service models and code go here
package.json project metadata and configuration
readme.md this getting started guide

Info

PlantUML offers a diagrams-as-code approach, where images are created from a textuell representation. There are simliar projects and you can find an intro here https://dev.to/simonbrown/diagrams-as-code-20eo

Also read this Blog for more use cases like VSC markdown support, integration into GitHub or GitLab.

Prerequisites

For local testing, the destinations need to be locally available! Since sharing credentials in a git repo is a bad idea in general, please copy the template

cp tpl-default-env.json default-env.json

to the used one, because this file is used by cap and ignored from git. The northwind example will work out-of-the-box. The s4hana destination is only for demonstration, how to enter auth credentials for destinations.

default-env.json

{
    "VCAP_SERVICES": {},
    "destinations": [
        {
            "name": "northwind",
            "url": "https://services.odata.org/V2/Northwind/Northwind.svc"
        },
        {
            "name": "s4hana",
            "url": "http://s4hana.system.de:8000/sap/opu/odata/sap/API_PRODUCT_SRV",
            "path": "/sap/opu/odata/sap/API_PRODUCT_SRV",
            "username": "<username>",
            "password": "<password>"
        }
    ]
}

Next Steps

  • Open a new terminal and run cds watch
  • Visual Studio Code
    • choose Terminal > Run Task > cds watch
    • or use NPM Scripts section and press run button on watch script
    • or press CTRL - SHIFT - B to run default build tasks used to start default services

Test Demos

The demos are available using auto starting launchpad http://localhost:4004 and the classic services site ia available using http://localhost:4004/services

gif

Test call rendering plain object

Just render an inline object using

http://localhost:4004/plantuml/renderTest()

svg

Northwind service call rendering orderById

http://localhost:4004/plantuml/renderNorthwindOrder(OrderID=10248)

svg

sap4kids YAML data

http://localhost:4004/plantuml/renderYaml()

svg

DB Schema

http://localhost:4004/plantuml/renderDBSchema()

svg

SEGW Sequence

http://localhost:4004/plantuml/renderSegw()

svg

Visual Studio Code Demo

If you are using Microsoft Visal Studio Code and the great extension REST Client by Huachao Mao, you will find addtional http test calls in the test folder.

To be able to externalize credentials (and maybe also host).

.env

User=xxx
Password=xxx

The extension substitutes POSTMAN and allows you to call REST services.

The Product.http file also showcases calling SAP API services with prefetching X-CSRF-Token, because you can depend on results of former calls.

Inside Northwind.http you can test the used call and maybe figure out, what i want too add as a nice goody ;-)

Generate JSON Diagram directly from REST Client

gif

Developing

While developing extensions for sap.fe, like custom views and fragments, the framework will use the XML View Cache. This cache uses the browsers local IndexedDB Storage and not the network cache. During development, you can disable the cache using an url parameter

sap-ui-xx-viewCache=false

Example url: http://localhost:4004/#Shell-home?sap-ui-xx-viewCache=false

Learn More

Learn more at https://cap.cloud.sap/docs/get-started/.