Customize Imports
Speakeasy allows you to customize the paths we generate models to and your users import models from.
By default, Speakeasy uses an OpenAPI-based naming scheme for the namespaces models are bucketed into, for example:
INFO
Currently only supported for C#, Go, Python, TypeScript, and Unity SDKs. More languages will be added soon.
Components
Models generated from components are placed in the models/components directory, or the target language idiomatic equivalent.
sdk/├─ models/│ ├─ components/│ │ ├─ user.ts│ │ ├─ drink.ts│ │ └─ ...│ ├─ operations/│ │ ├─ getuser.ts│ │ ├─ updateuser.ts│ │ ├─ getdrink.ts│ │ ├─ updatedrink.ts│ │ └─ ...│ └─ errors/│ ├─ sdkerror.ts│ ├─ responseerror.ts│ └─ ...└─ ...
Operations
Models generated from operations are placed in the models/operations directory, or the target language idiomatic equivalent.
sdk/├─ models/│ ├─ components/│ │ ├─ user.ts│ │ ├─ drink.ts│ │ └─ ...│ ├─ operations/│ │ ├─ getuser.ts│ │ ├─ updateuser.ts│ │ ├─ getdrink.ts│ │ ├─ updatedrink.ts│ │ └─ ...│ └─ errors/│ ├─ sdkerror.ts│ ├─ responseerror.ts│ └─ ...└─ ...
Errors
Models that are used in error status codes are placed in the models/errors directory, or the target language idiomatic equivalent.
sdk/├─ models/│ ├─ components/│ │ ├─ user.ts│ │ ├─ drink.ts│ │ └─ ...│ ├─ operations/│ │ ├─ getuser.ts│ │ ├─ updateuser.ts│ │ ├─ getdrink.ts│ │ ├─ updatedrink.ts│ │ └─ ...│ └─ errors/│ ├─ sdkerror.ts│ ├─ responseerror.ts│ └─ ...└─ ...
Components
Models generated from components are placed in the models/components directory, or the target language idiomatic equivalent.
Operations
Models generated from operations are placed in the models/operations directory, or the target language idiomatic equivalent.
Errors
Models that are used in error status codes are placed in the models/errors directory, or the target language idiomatic equivalent.
sdk/├─ models/│ ├─ components/│ │ ├─ user.ts│ │ ├─ drink.ts│ │ └─ ...│ ├─ operations/│ │ ├─ getuser.ts│ │ ├─ updateuser.ts│ │ ├─ getdrink.ts│ │ ├─ updatedrink.ts│ │ └─ ...│ └─ errors/│ ├─ sdkerror.ts│ ├─ responseerror.ts│ └─ ...└─ ...
Customize Import Paths
imports
Customize where path models are generated to and imported from by modifying the configuration in the gen.yaml file.
Configuration like what is shown will result in a file structure as above.
option
The option key determines the type of bucketing scheme that is used for the models.
Only openapi is currently supported. This will bucket models into components, operations, errors, callbacks, and webhooks directories.
paths
The paths section contains a map of bucket names to paths relative to the root of the generated SDK.
sharedrefers to the models generated from thecomponentssection of the OpenAPI specification. (Note:sharedis a legacy name for the bucket, retained for backward compatibility.)operationsrefers to the models generated for the request and responses of operations in the OpenAPI specification.errorsrefers to the models generated for schemas referenced in error status codes responses.callbacksrefers to models generated for schemas within thecallbackssection of an operation.webhooksrefers to models generated from thewebhookssection of an OpenAPI 3.1 document.
imports
Customize where path models are generated to and imported from by modifying the configuration in the gen.yaml file.
Configuration like what is shown will result in a file structure as above.
option
The option key determines the type of bucketing scheme that is used for the models.
Only openapi is currently supported. This will bucket models into components, operations, errors, callbacks, and webhooks directories.
paths
The paths section contains a map of bucket names to paths relative to the root of the generated SDK.
sharedrefers to the models generated from thecomponentssection of the OpenAPI specification. (Note:sharedis a legacy name for the bucket, retained for backward compatibility.)operationsrefers to the models generated for the request and responses of operations in the OpenAPI specification.errorsrefers to the models generated for schemas referenced in error status codes responses.callbacksrefers to models generated for schemas within thecallbackssection of an operation.webhooksrefers to models generated from thewebhookssection of an OpenAPI 3.1 document.
You can customize these paths to any path that exists relative to the root of the SDK.
CAUTION
If you are providing custom path names, make sure there is no conflict with any of the existing directories in the SDK. Conflicts will result in compilation issues.
Different buckets can also be configured to use the same path, for example:
This will result in all models being generated to the models directory. The generator will then resolve any class name conflicts by prefixing or suffixing class names to ensure they are unique.
Customize Global Imports
You can configure the generator to work with a global import path for all models.
For example:
import { User, GetDrinkRequest, SDK } from '@speakeasy/bar'
Instead of:
import { SDK } from '@speakeasy/bar'import { User } from '@speakeasy/bar/dist/models/components/user'import { GetDrinkRequest } from '@speakeasy/bar/dist/models/operations/user'
You will configure global imports slightly differently for different languages:
For TypeScript to configure global imports, the imports section of your gen.yaml needs to include the following:
For global imports in TypeScript, models will always be generated to the models directory, regardless of whether the "" or "models" path is specified. However, global imports will only kick in if one of these two values is used for all buckets. This is to ensure the root directory isn't cluttered with files.
The configuration example above will result in a directory structure like this:
/├─ src│ ├─ models/│ │ ├─ user.ts│ │ ├─ drink.ts│ │ ├─ getuser.ts│ │ ├─ updateuser.ts│ │ ├─ getdrink.ts│ │ ├─ updatedrink.ts│ │ ├─ sdkerror.ts│ │ ├─ responseerror.ts│ │ ├─ index.ts│ │ └─ ...│ └─ ...└─ ...
Import models like so:
import { User, GetDrinkRequest, SDK } from '@speakeasy/bar'
CAUTION
Global imports will cause namespace pollution for the import and file clutter in the directory models are generated to.
Large APIs containing many models (especially many inline models) will inevitably lead to name conflicts. Rename types verbosely to ensure each class is unique within the namespace.