Swift
This section details the available configuration options for the Swift SDK. All configuration is managed in the gen.yaml file under the swift section.
General configuration
swift:
version: 1.2.3
author: "Speakeasy"
packageName: "openapi"
description: "Swift Client SDK Generated by Speakeasy"
| Name | Required | Default Value | Description |
|---|---|---|---|
| version | true | 0.0.1 | The current version of the SDK. |
| packageName | true | OpenAPI | The name of the Swift Package Manager (SPM) package. |
| author | true | Speakeasy | The name of the author of the published package. |
| description | true | Swift Client SDK Generated by Speakeasy | A short description of the SDK. |
| documentationBaseURL | false | "" | The base URL to the hosted documentation site. |
Import management
swift:
imports:
option: "openapi"
paths:
callbacks: models/callbacks
errors: models/errors
operations: models/operations
shared: models/components
webhooks: models/webhooks
| Field | Required | Default Value | Description |
|---|---|---|---|
| option | false | "openapi" | Defines the type of import strategy. Typically set to "openapi", indicating that the structure is based on the OpenAPI document. |
| paths | false | {} | Customizes where different parts of the SDK (e.g., callbacks, errors, and operations) will be imported from. |
Import paths
| Component | Default Value | Description |
|---|---|---|
| callbacks | models/callbacks | The directory where callback models will be imported from. |
| errors | models/errors | The directory where error models will be imported from. |
| operations | models/operations | The directory where operation models (i.e., API endpoints) will be imported from. |
| shared | models/components | The directory for shared components, such as reusable schemas, and data models imported from the OpenAPI spec. |
| webhooks | models/webhooks | The directory for webhook models, if your SDK includes support for webhooks. |
