Configure SDK generation in Postman

The Postman SDK Generator postman-sdk.config.json config file contains the configuration used by the Postman SDK CLI to generate SDKs. Power users who require deeper customization can provide a full postman-sdk.config.json file. See Advanced options for more information.

At a minimum, set the location of your API specification and the SDK languages you want to generate in the config file:

1 {
2   ...
3   "specFilePath": "https://petstore3.swagger.io/api/v3/openapi.json",
4   "languages": ["typescript", "python", "java", "kotlin", "csharp", "go", "php", "ruby", "rust", "cli"]
5   ...
6 }

The config file contains options that enable you to customize the SDKs you generate. One of the most powerful features of the Postman SDK Generator is the ability to get fine-grained control over the SDK generation process.

The Postman SDK CLI uses a configuration file instead of extensions in your API specification to allow you to keep a separation between your specification and SDK generation. This provides one source for the configuration, and allows you to quickly make changes without having to redeploy your API if your specification is created by your API gateway.

Create and manage the Postman SDK config file

To create the config file, run the postman sdk init command.

By default, the config file is located in the .postman/config.json root of your project. When you run CLI commands such as postman sdk generate, the CLI looks for this config file in the current working directory.

You can change the name and location of the config file by passing the --config option to the CLI commands. This supports local and remote config files.

$ postman sdk generate --config <PATH_OF_POSTMAN_CONFIG_FILE>

The specFilePath option in the config file is always relative to the current working directory that the CLI is being run from, not relative to the config file location.

Postman SDK config file structure

The config file defines the SDK to create, along with the configuration based on your API. It also defines sections for generic customizations, language specific customizations, publishing, and configuring validation.

1 {
2   "schemaVersion": "1",
3   "workspace": {},
4   "entities": {},
5   "sdk": {
6     "sdkName": "",
7     "languages": ["typescript", "python", "java", "kotlin", "csharp", "go", "php", "ruby", "rust", "cli"],
8     "customizations": {
9       "environments": [],
10       "license": {
11         "type": "NONE"
12       },
13       "retry": {
14         "enabled": true,
15         "maxAttempts": 3,
16         "retryDelay": 150
17       }
18     },
19     "languageOptions": {
20       "typescript": {
21         "bundle": true,
22         "denoteCommon": false,
23         "exportClassDefault": false
24       },
25       "java": {},
26       "python": {},
27       "kotlin": {},
28       "csharp": {},
29       "go": {},
30       "php": {
31         "packageName": "company/sdk"
32       },
33       "ruby": {},
34       "rust": {},
35       "cli": {
36         "skills": { "enabled": false }
37       }
38     },
39     "analytics": {
40         "enabled": true,
41         "exporter": "otlp-http",
42         "endpoint": "https://insights.postman.com/v3/traces",
43         "headers": {
44           "Content-Type": "application/json"
45           // any other custom header
46         },
47         "batchSize": 100,
48         "scheduledDelayMillis": 5000,
49         "serviceName": "your-sdk"
50     }
51   }
52 }

Advanced options

The following topics provide more information about config file sections: