onedevatlasBeta
Browse the atlas
AllCAPUI5ABAPBTP
SampleSampletypeA worked example you read or clone. Evidence: it demonstrates, it never provides.See every one →What this type is →independently maintainedindependently maintainedoriginPublished by one person or a small company outside SAP. Says nothing about quality; the readings say that.See every one →Reference

cap-external-northwind

A CAP service that serves an external OData service as its own: Northwind's Products imported as a CSN model, projected read-only, with the incoming query run against the remote service.

The imported model sits in srv/external/NorthWind.csn and is declared under cds.requires in package.json as kind: odata with credentials: { destination: 'NorthWind' }, naming the destination it is reached through. CatalogService.Products is a @readonly projection naming seven elements, the implementation connects to NorthWind once at init, and its single READ handler runs request.query against that service inside the request's transaction. Beside the model folder srv/ holds only those two files, and sqlite3 is the one devDependency, so the imported model, the requires block and that handler are the whole of it. One commit, from July 2021, on a master branch.

GitHub0 ★

Facts

Last pushLicenceUNLICENSED

Where it sits

Lives in
CAP
Demonstrates
Service integrationCAPService integrationcapabilityUsing a service that runs somewhere else as if it were one of your own: its API imported into the model, a proxy that turns a local query into the remote protocol, and a mock that stands in for it on a laptop. Distinct from [destinations](capability:destinations), which is how the address and the credentials are found, and from [replication](capability:replication), which is holding the data locally.DestinationsCAPDestinationscapabilityReaching a system that is not yours — an S/4HANA tenant, an on-premise service, a third-party API — without the address, the credentials or the tunnel being written into the application. The destination is the indirection, and the reason an endpoint can move without a redeploy.
Flavors
Node.jsfrom its runtime
Requires
@sap/cds^5@sap/cdsartifactThe peer range, as published.SAP Destination serviceSAP Destination serviceartifactHow the remote service is reached once deployed: the project's own requires block names a destination instead of an address, and the repository does not set that destination up.

Who is behind it

Mio YasutakeMio YasutakePersonMaintains this
In the atlas: maintains 47, contributes to 47, wrote 10@miyasutamaintainer

What it declares

Every artifact

Type
Sample
Origin
Independently maintained
Use as
A reference
Runtime
Node.js

As a sample

Declared for
^5
Form
does not say

Connections3

README

quoted from miyasuta/cap-external-northwind, read
miyasuta/cap-external-northwind/README.mdOn GitHub

Getting Started

Welcome to your new project.

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

File or FolderPurpose
app/content for UI frontends goes here
db/your domain models and data go here
srv/your service models and code go here
package.jsonproject metadata and configuration
readme.mdthis getting started guide
excerpt, UNLICENSED, read the rest, on GitHub

Details

Sources3
GitHub APIdiscovered here, miyasutachecked
github.com/miyasuta/cap-external-northwindtree, pushes, contributors, CIchecked
README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
runtimesnode
declared for^5
discovered viaGitHub API · miyasuta
first seen in the atlas
ecosystem and domaincap, integration-and-messaging
History in the atlas1
  1. First seen.
For your agent
Ref
artifact:miyasuta-cap-external-northwind
JSON
/artifacts/miyasuta-cap-external-northwind.json
MCP
Connecting an agent