mirror of
https://github.com/swift-server/swift-openapi-async-http-client.git
synced 2026-05-03 07:42:29 +00:00
44 lines
2.2 KiB
Markdown
44 lines
2.2 KiB
Markdown
# AsyncHTTPClient Transport for Swift OpenAPI Generator
|
|
|
|
[](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client/documentation)
|
|
[](https://github.com/swift-server/swift-openapi-async-http-client/releases)
|
|
[](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client)
|
|
[](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client)
|
|
|
|
A client transport that uses the [HTTPClient](https://swiftpackageindex.com/swift-server/async-http-client/documentation/asynchttpclient/httpclient) type from the [AsyncHTTPClient](https://github.com/swift-server/async-http-client) library to perform HTTP operations.
|
|
|
|
Use the transport with client code generated by [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator).
|
|
|
|
## Supported platforms and minimum versions
|
|
| macOS | Linux | iOS | tvOS | watchOS | visionOS |
|
|
| :-: | :-: | :-: | :-: | :-: | :-: |
|
|
| ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ | ✅ 1+ |
|
|
|
|
## Swift version compatibility
|
|
| Swift | Package Version |
|
|
| :----------: | :-------------: |
|
|
| 6.0+ | 1.3.0+ |
|
|
| 5.10 - 5.11 | 1.0.0 - 1.2.0 |
|
|
|
|
## Usage
|
|
|
|
Add the package dependency in your `Package.swift`:
|
|
|
|
```swift
|
|
.package(url: "https://github.com/swift-server/swift-openapi-async-http-client", from: "1.0.0"),
|
|
```
|
|
|
|
Next, in your target, add `OpenAPIAsyncHTTPClient` to your dependencies:
|
|
|
|
```swift
|
|
.target(name: "MyTarget", dependencies: [
|
|
.product(name: "OpenAPIAsyncHTTPClient", package: "swift-openapi-async-http-client"),
|
|
]),
|
|
```
|
|
|
|
Then, to get started, check out `AsyncHTTPClientTransport`.
|
|
|
|
## Documentation
|
|
|
|
To learn more, check out the full [documentation](https://swiftpackageindex.com/swift-server/swift-openapi-async-http-client/documentation).
|