Swift OpenAPI Generator
Generate Swift client and server code from an OpenAPI document.
Overview
OpenAPI is an open specification for documenting HTTP APIs.
Swift OpenAPI Generator is a Swift package plugin that can generate the ceremony code required to make API calls, or implement API servers.
Repository organization
The Swift OpenAPI Generator project is split across multiple repositories to enable extensibility and minimize dependencies in your project.
swift-openapi-generator (source, docs) provides the plugin.
swift-openapi-runtime (source, docs) provides a library with common types and abstractions used by the generated code.
See the generator in action in Meet Swift OpenAPI Generator from WWDC23.
Choose one of the transports listed below, or create your own by adopting the ClientTransport or ServerTransport protocol:
| Repository | Type | Description |
|---|---|---|
| apple/swift-openapi-urlsession | Client | Uses URLSession from Foundation. |
| swift-server/swift-openapi-async-http-client | Client | Uses HTTPClient from AsyncHTTPClient. |
| swift-server/swift-openapi-vapor | Server | Uses Vapor. |
| swift-server/swift-openapi-hummingbird | Server | Uses Hummingbird. |
Requirements and supported features
| Generator versions | Supported OpenAPI versions | Minimum Swift version |
|---|---|---|
0.1.0 ... 0.1.11 |
3.0 | 5.8 |
0.1.12 ... main |
3.0, 3.1 | 5.8 |
Supported platforms and minimum versions
The generator is used during development and is supported on macOS and Linux.
The generated code, runtime library, and transports are supported on more platforms, listed below.
| Component | macOS | Linux | iOS | tvOS | watchOS |
|---|---|---|---|---|---|
| Generator plugin and CLI | ✅ 10.15+ | ✅ | ❌ | ❌ | ❌ |
| Generated code, runtime, transports | ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ |
Documentation
To get started, check out the full documentation, which contains step-by-step tutorials!
GitHub
| link |
| Stars: 642 |
| Last commit: 2 days ago |
Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.
Dependencies
Release Notes
What's Changed
SemVer Patch
- Add support for nullable schemas by @czechboy0 in https://github.com/apple/swift-openapi-generator/pull/248
- Bump OpenAPIKit to beta.5 by @czechboy0 in https://github.com/apple/swift-openapi-generator/pull/266
- Escape negative numbers in integer-backed enums by @PARAIPAN9 in https://github.com/apple/swift-openapi-generator/pull/274
- [Generator] Fix nested coding by @czechboy0 in https://github.com/apple/swift-openapi-generator/pull/271
Other Changes
- Fixes #114 - Add scoped imports by @PARAIPAN9 in https://github.com/apple/swift-openapi-generator/pull/184
- Audit for the word "content" incorrectly used to refer to body in public API by @czechboy0 in https://github.com/apple/swift-openapi-generator/pull/256
- Use per-type imports everywhere by @czechboy0 in https://github.com/apple/swift-openapi-generator/pull/264
- Add compatibility suite with selected OpenAPI documents by @simonjbeaumont in https://github.com/apple/swift-openapi-generator/pull/267
- Delete temporary build directories in compatibility test by @simonjbeaumont in https://github.com/apple/swift-openapi-generator/pull/277
- Run integration test in $TMPDIR or /tmp by @simonjbeaumont in https://github.com/apple/swift-openapi-generator/pull/279
- Compile with -warnings-as-errors in CI (incl. StrictSendability) by @simonjbeaumont in https://github.com/apple/swift-openapi-generator/pull/281
- Generate all requested modes in parallel by @simonjbeaumont in https://github.com/apple/swift-openapi-generator/pull/280
New Contributors
- @PARAIPAN9 made their first contribution in https://github.com/apple/swift-openapi-generator/pull/184
Full Changelog: https://github.com/apple/swift-openapi-generator/compare/0.2.1...0.2.2
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics