Skip to content

(sdks) Swift documentation updates – new enableWireTests option, fix version number #1117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 4, 2025
Merged

(sdks) Swift documentation updates – new enableWireTests option, fix version number #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c67d79
add new wire tests option, fix version number
devalog Oct 4, 2025
5b186a8
wording update
devalog Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion fern/products/sdks/guides/testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,14 @@ Fern generates unit tests for all SDK languages. They verify individual methods

Mock server (wire) tests run your SDK against a mock server generated from your API definition. They verify that the SDK sends HTTP requests and receives HTTP responses as expected. These tests are generated for all endpoints in a service.

Mock server tests are available for TypeScript, Go, and Java. Configure mock server tests in your `generators.yml`:
Mock server tests are available for TypeScript, Go, Java, and Swift. Configure mock server tests in your `generators.yml`:

| Language | Configuration | Default |
|----------|---------------|---------|
| TypeScript | [`generateWireTests`](/sdks/generators/typescript/configuration#generatewiretests) | true |
| Go | [`enableWireTests`](/sdks/generators/go/configuration#enablewiretests) | false |
| Java | [`enable-wire-tests`](/sdks/generators/java/configuration#enablewiretests) | false |
| Swift | [`enableWireTests`](/sdks/generators/swift/configuration#enablewiretests) | true |

## Integration tests

Expand Down
7 changes: 6 additions & 1 deletion fern/products/sdks/overview/swift/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Configuration options for the Fern Swift SDK.

You can customize the behavior of the Swift SDK generator in `generators.yml`:

```yaml {6-9} title="generators.yml"
```yaml {6-10} title="generators.yml"
groups:
swift-sdk:
generators:
Expand All @@ -15,6 +15,7 @@ groups:
clientClassName: YourClientName
environmentEnumName: YourCustomEnvironment
moduleName: MyCustomModule
enableWireTests: false
```

## SDK Configuration Options
Expand All @@ -30,3 +31,7 @@ The name of the generated environment enum. This allows you to customize the enu
<ParamField path="moduleName" type="string" required={false} toc={true}>
The module name used in client code (e.g., `import MyCustomModule`). When provided, this name is used consistently across the library, product, and target.
</ParamField>

<ParamField path="enableWireTests" type="boolean" default="true" required={false} toc={true}>
Generates [mock server (wire) tests](/sdks/deep-dives/testing#mock-server-tests) to verify that the SDK sends the correct HTTP requests and correctly handles responses per the API spec.
</ParamField>
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/swift/publishing-to-swift-package-manager.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Publish your public-facing Fern Swift SDK as a Swift package distributed via Git
swift-sdk:
generators:
- name: fernapi/fern-swift-sdk
version: 1.0.0
version: <Markdown src="/snippets/version-number-swift.mdx"/>
github:
repository: your-org/company-swift
```
Expand Down