SAP Cloud SDK OpenAPI Client Generator (Beta)

Generate custom JavaScript/TypeScript clients for services with OpenAPI specifications. 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.

Prerequisites

The official OpenAPI generator is Java based, therefore you need to have a Java runtime installed to use the SAP Cloud SDK OpenAPI generator.

Installation

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

Usage (CLI)

generate-openapi-client autocomplete [SHELL]
generate-openapi-client help [COMMAND]

`generate-openapi-client autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ generate-openapi-client autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ generate-openapi-client autocomplete
  $ generate-openapi-client autocomplete bash
  $ generate-openapi-client autocomplete zsh
  $ generate-openapi-client autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`generate-openapi-client help [COMMAND]`

display help for generate-openapi-client

USAGE
  $ generate-openapi-client help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

Usage (programatically)

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

// initialize generator options based on what you want to do
// note that inputDir and outputDir are mandatory
const options: GeneratorOptions = {
  inputDir: 'path/to/inputDir',
  outputDir: 'path/to/outputDir'
};

// generates the files and writes them to the outputDir
await generate(options);

Documentation

Getting started guide API documentation

Helpful Links

Index

Interfaces

Type aliases

Method

Functions

Type aliases

Method

Method: typeof supportedMethods[keyof typeof supportedMethods]

experimental: This API is experimental and might change in newer versions. Use with caution. Methods supported by OpenApi and SAP Cloud SDK.

Functions

apiFile

apiFile(openApiDocument: OpenApiDocument): string

- Defined in packages/openapi-generator/src/wrapper-files/api-file.ts:19
experimental

This API is experimental and might change in newer versions. Use with caution. Get the content of the SAP Cloud SDK API wrapper.

Parameters
- openApiDocument: OpenApiDocument
  
  Parsed service.
Returns string

The generated code for the SDK API wrapper.

convertDocToGlobalTag

convertDocToGlobalTag(openApiDocument: Document): Document

- Defined in packages/openapi-generator/src/document-converter.ts:71
Workaround for OpenAPI generation to build one and only one API for all tags. Modify spec to contain only one 'default' tag.

Parameters
- openApiDocument: Document
  
  OpenAPI JSON document.
Returns Document

The modified document.

convertDocToOpenApiV3

convertDocToOpenApiV3(openApiDocument: Record<string, any>): Promise<Document>

- Defined in packages/openapi-generator/src/document-converter.ts:51
Convert Swagger documents to OpenAPI documents. If an OpenAPI document is passed it is not modified.

Parameters
- openApiDocument: Record<string, any>
  
  OpenAPI version 2 (Swagger) or 3 document to be converted to version 3.
Returns Promise<Document>

A promise of an OpenAPI version 3 document.

convertOpenApiSpec

convertOpenApiSpec(filePath: string): Promise<Document>

- Defined in packages/openapi-generator/src/document-converter.ts:15
Convert an OpenAPI document to ensure smooth parsing and generation thereafter. Documents are expected to be formatted as JSON, OpenAPI version 3 and only have one "default" tag.

Parameters
- filePath: string
  
  File content of the original spec.
Returns Promise<Document>

createFile

createFile(directoryPath: string, fileName: string, content: string, overwrite: boolean): Promise<void>

- Defined in packages/openapi-generator/src/wrapper-files/create-file.ts:14
experimental

This API is experimental and might change in newer versions. Use with caution. Write a file generated by the SAP Cloud SDK for JavaScript containing a copyright statement.

Parameters
- directoryPath: string
  
  Path of the directory to write to.
- fileName: string
  
  Name of the file to write
- content: string
  
  Content to be written to the file. A copyright statement will be added to this.
- overwrite: boolean
  
  Whether or not existing files should be overwritten.
Returns Promise<void>

filterDuplicateParams

filterDuplicateParams(parameters: ParameterObject[]): ParameterObject[]

- Defined in packages/openapi-generator/src/parser/parameters.ts:64
Parameters
- parameters: ParameterObject[]
Returns ParameterObject[]

generate

generate(options: GeneratorOptions): Promise<void>

- Defined in packages/openapi-generator/src/generator.ts:22
experimental

This API is experimental and might change in newer versions. Use with caution. Main entry point for OpenApi client generation. Generates files using the OpenApi Generator CLI and wraps the resulting API in an SDK compatible API.

Parameters
- options: GeneratorOptions
  
  Options to configure generation.
Returns Promise<void>

getOperation

getOperation(pathItem: PathItemObject, method: Method): OperationObject

- Defined in packages/openapi-generator/src/parser/operation.ts:36
Get the operation for the given method and merge path parameters with operation parameters.

Parameters
- pathItem: PathItemObject
  
  Path Item to get the operation from.
- method: Method
  
  HTTP method to get the operation for.
Returns OperationObject

The sanitized original operation.

getType

getType(originalType: string | undefined): string

- Defined in packages/openapi-generator/src/parser/type-mapping.ts:44
Get the mapped TypeScript type for the given original OpenApi type.

Parameters
- originalType: string | undefined
  
  Original OpenApi type, to get a mapping for.
Returns string

The mapped TypeScript type.

indexFile

indexFile(): string

- Defined in packages/openapi-generator/src/wrapper-files/index-file.ts:8
experimental

This API is experimental and might change in newer versions. Use with caution. Generate the index file to expose the SAP Cloud SDK API and models.

Returns string

The index file contents.

isArraySchemaObject

isArraySchemaObject(obj: any): obj is ArraySchemaObject

- Defined in packages/openapi-generator/src/parser/schema.ts:8
Type guard to check whether an object is of type OpenAPIV3.ArraySchemaObject.

Parameters
- obj: any
  
  Object to check.
Returns obj is ArraySchemaObject

True if the object is a array schema object, false otherwise.

isReferenceObject

isReferenceObject(obj: any): obj is ReferenceObject

- Defined in packages/openapi-generator/src/parser/refs.ts:10
Type guard to check whether an object is of type OpenAPIV3.ReferenceObject.

Parameters
- obj: any
  
  Object to check.
Returns obj is ReferenceObject

True if the object is a reference object, false otherwise.

methods

methods(): Method[]

- Defined in packages/openapi-generator/src/openapi-types.ts:45
experimental

This API is experimental and might change in newer versions. Use with caution. Get supported methods.

Returns Method[]

Methods supported by OpenApi and SAP Cloud SDK.

parseAllOperations

parseAllOperations(document: Document, refs: $Refs): OpenApiOperation[]

- Defined in packages/openapi-generator/src/parser/document.ts:27
Collect and parse all operations of an OpenAPIV3.Document.

Parameters
- document: Document
  
  The OpenApi document to parse.
- refs: $Refs
  
  List of cross references that can occur in the document.
Returns OpenApiOperation[]

A flat list of parsed operations.

parseFileAsJson

parseFileAsJson(filePath: string): Promise<Record<string, any>>

- Defined in packages/openapi-generator/src/document-converter.ts:28
Parse a JSON or YAML file and return it as JSON.

Parameters
- filePath: string
  
  Path to the file
Returns Promise<Record<string, any>>

JSON representation of the given file.

parseOpenApiDocument

parseOpenApiDocument(fileContent: Document, serviceName: string): Promise<OpenApiDocument>

- Defined in packages/openapi-generator/src/parser/document.ts:7
Parameters
- fileContent: Document
- serviceName: string
Returns Promise<OpenApiDocument>

parseOperation

parseOperation(pattern: string, pathItem: PathItemObject, method: Method, refs: $Refs): OpenApiOperation

- Defined in packages/openapi-generator/src/parser/operation.ts:8
Parameters
- pattern: string
- pathItem: PathItemObject
- method: Method
- refs: $Refs
Returns OpenApiOperation

parseOperationName

parseOperationName(operation: OperationObject, pattern: string, method: Method): string

- Defined in packages/openapi-generator/src/parser/operation.ts:53
Parameters
- operation: OperationObject
- pattern: string
- method: Method
Returns string

parseParameters

parseParameters(operation: OperationObject, refs: $Refs): OpenApiParameter[]

- Defined in packages/openapi-generator/src/parser/parameters.ts:18
Parse parameters of an operation.

Parameters
- operation: OperationObject
  
  The original operation definition.
- refs: $Refs
  
  List of cross references that can occur in the document.
Returns OpenApiParameter[]

A list of parsed parameters.

parseRequestBody

parseRequestBody(requestBody: ReferenceObject | RequestBodyObject | undefined, refs: $Refs): OpenApiRequestBody | undefined

- Defined in packages/openapi-generator/src/parser/request-body.ts:14
Parse the request body.

Parameters
- requestBody: ReferenceObject | RequestBodyObject | undefined
  
  Original request body to parse.
- refs: $Refs
  
  List of cross references that can occur in the document.
Returns OpenApiRequestBody | undefined

The parsed request body.

parseSchemaMetadata

parseSchemaMetadata(schema?: ReferenceObject | ArraySchemaObject | NonArraySchemaObject): SchemaMetadata | undefined

- Defined in packages/openapi-generator/src/parser/request-body.ts:47
Parameters
- Optional schema: ReferenceObject | ArraySchemaObject | NonArraySchemaObject
Returns SchemaMetadata | undefined

parseTypeName

parseTypeName(obj: ReferenceObject): string

- Defined in packages/openapi-generator/src/parser/refs.ts:19
Parse the type name of a reference object.

Parameters
- obj: ReferenceObject
  
  Reference object to get the type name from.
Returns string

Parsed type name.

renameEquallyNamedParams

renameEquallyNamedParams(parameters: ParameterObject[]): ParameterObject[]

- Defined in packages/openapi-generator/src/parser/parameters.ts:80
Parameters
- parameters: ParameterObject[]
Returns ParameterObject[]

resolveObject

resolveObject<T>(obj: T | ReferenceObject, refs: $Refs): T

- Defined in packages/openapi-generator/src/parser/refs.ts:31
Check whether the given object is a reference object and resolve if necessary. This operates only on the current level and does not resolve the object recursively.

Type parameters
- T
Parameters
- obj: T | ReferenceObject
  
  Object to resolve if necessary.
- refs: $Refs
  
  References to resolve by.
Returns T

A resolved object.

SAP Cloud SDK OpenAPI Client Generator (Beta)

Prerequisites

Installation

Usage (CLI)

generate-openapi-client autocomplete [SHELL]

generate-openapi-client help [COMMAND]

Usage (programatically)

Documentation

Helpful Links

Index

Interfaces

Type aliases

Functions

Type aliases

Method

Functions

apiFile

Parameters

openApiDocument: OpenApiDocument

Returns string

convertDocToGlobalTag

Parameters

openApiDocument: Document

Returns Document

convertDocToOpenApiV3

Parameters

openApiDocument: Record<string, any>

Returns Promise<Document>

convertOpenApiSpec

Parameters

filePath: string

Returns Promise<Document>

createFile

Parameters

directoryPath: string

fileName: string

content: string

overwrite: boolean

Returns Promise<void>

filterDuplicateParams

Parameters

parameters: ParameterObject[]

Returns ParameterObject[]

generate

Parameters

options: GeneratorOptions

Returns Promise<void>

getOperation

Parameters

pathItem: PathItemObject

method: Method

Returns OperationObject

getType

Parameters

originalType: string | undefined

Returns string

indexFile

Returns string

isArraySchemaObject

Parameters

obj: any

Returns obj is ArraySchemaObject

isReferenceObject

Parameters

obj: any

Returns obj is ReferenceObject

methods

Returns Method[]

parseAllOperations

Parameters

document: Document

refs: $Refs

Returns OpenApiOperation[]

parseFileAsJson

Parameters

filePath: string

Returns Promise<Record<string, any>>

parseOpenApiDocument

Parameters

fileContent: Document

`generate-openapi-client autocomplete [SHELL]`

`generate-openapi-client help [COMMAND]`