API Reference
generateSwiftClient
Generate a native Swift client from a Kizuna API with URLSession and Codable.
Generate a native Swift client from your routes, built on URLSession and Codable.
pnpm add @kizunajs/swift@betabun add @kizunajs/swift@betanpm install @kizunajs/swift@betaimport { generateSwiftClient } from '@kizunajs/swift';Parameters
generateSwiftClient(api: ApiDefinition, config: SwiftConfig): string| Parameter | Type | Description |
|---|---|---|
api | ApiDefinition | The api from defineConfig |
config | SwiftConfig | Generation configuration |
SwiftConfig
| Option | Type | Required | Description |
|---|---|---|---|
namespaceName | string | Yes | Name for the generated Swift enum and client type (e.g. 'API') |
camelCaseProperties | boolean | No | Convert wire field names to camelCase properties, mapped back via CodingKeys. Default false |
unknownEnumCase | boolean | No | Emit enums with an unknown(String) fallback so unrecognised wire values decode instead of throwing. Default false |
Example
import { writeFileSync } from 'node:fs';
import { generateSwiftClient } from '@kizunajs/swift';
import kizuna from '../kizuna.config';
const source = generateSwiftClient(kizuna.api, {
namespaceName: 'API',
});
writeFileSync('generated/API.swift', source);See the Swift client guide for CLI usage and integration patterns.