mirror of
https://github.com/swift-server/swift-openapi-async-http-client.git
synced 2026-05-03 07:42:29 +00:00
Honza Dvorsky
701d752f25
### Motivation Surface the Swift version and platform support status from Swift Package Index. ### Modifications Added badges, plus a quick link to the docc docs, to the top of the README. Also, expanded the supported platforms, we do actually support iOS and friends (was an oversight not to include it before). ### Result Easier to quickly see our support matrix, plus the quick link to docs. ### Test Plan Previewed locally.
AsyncHTTPClient Transport for Swift OpenAPI Generator
A client transport that uses the HTTPClient type from the AsyncHTTPClient library to perform HTTP operations.
Use the transport with client code generated by Swift OpenAPI Generator.
Supported platforms and minimum versions
| macOS | Linux | iOS | tvOS | watchOS |
|---|---|---|---|---|
| ✅ 10.15+ | ✅ | ✅ 13+ | ✅ 13+ | ✅ 6+ |
Usage
Add the package dependency in your Package.swift:
.package(
url: "https://github.com/swift-server/swift-openapi-async-http-client",
.upToNextMinor(from: "0.3.0")
),
Note that this repository does not have a 1.0 tag yet, so the API is not stable.
Next, in your target, add OpenAPIAsyncHTTPClient to your dependencies:
.target(name: "MyTarget", dependencies: [
.product(name: "OpenAPIAsyncHTTPClient", package: "swift-openapi-async-http-client"),
],
Then, to get started, check out AsyncHTTPClientTransport.
Reporting issues
Please report any issues related to this library in the swift-openapi-generator repository.
Documentation
To learn more, check out the full documentation.