SAP Cloud SDK for JavaScript Logo


This package contains the generator to create your own service module using a OpenAPI specification. This generator is based on the OpenAPI Tools generator for OpenAPI and adds some additional code for convenience to better integrate with the SAP Cloud SDK.


$ npm install @sap-cloud-sdk/openapi-generator

To run the CLI locally, compile and link the package.

$ yarn install

$ yarn compile

$ npm link

$ openapi-generator help

Usage (CLI)

The generator is primarily meant to be used on the command line:

npx openapi-generator --input path/to/your/service-specification(s) --outputDir path/where/the/modules/are/stored

Run openapi-generator --help for further options.

Usage (programatically)

You can also use the generator programmatically. You will have to provide the options anyways.

import { generate } from '@sap-cloud-sdk/openapi-generator';

// initialize generator options based on what you want to do
const options: GeneratorOptions = initializeOptions();

// generate the client using the provided options

For more detailed overview visit our generator documentation.


The recommended way to get in touch with us is to create an issue on GitHub. Select the issue category Bug, Feature, or Question depending on the nature of your request. We try to provide fixes, features and answers as soon as possible.


If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.



The SAP Cloud SDK is released under the Apache License Version 2.0.


Type Aliases



Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.