Swift OpenAPI URLSession Transport

repository·main·Indexed 42 days ago

https://github.com/apple/swift-openapi-urlsession

A client transport for the Swift OpenAPI Generator that leverages Apple's Foundation URLSession to perform HTTP operations. It provides the URLSessionTransport type and supports macOS 10.15+, iOS 13+, tvOS 13+, watchOS 6+, visionOS 1+, and Linux/Windows.

Tokens: 820
Snippets: 2
Records: 6
Agent score: 3%

What's inside Swift OpenAPI URLSession

Use OpenAPIURLSession with Swift OpenAPI Generator
main
This library provides a client transport that uses URLSession from the Foundation framework to perform HTTP operations. It is designed to be used with client code generated by the Swift OpenAPI Generator. To begin implementation, use the URLSessionTransport type.
https://github.com/apple/swift-openapi-urlsession/blob/main/Sources/OpenAPIURLSession/Documentation.docc/Documentation.md
Use URLSessionTransport with generated clients
main
The URLSessionTransport is the primary entry point for performing HTTP operations using the Foundation URLSession framework. It is designed to be passed into the client code generated by the Swift OpenAPI Generator.
https://github.com/apple/swift-openapi-urlsession/blob/main/README.md
Install OpenAPIURLSession via Swift Package Manager
main
To use this transport, add the swift-openapi-urlsession package to your Package.swift file. First, add the package dependency, then include the OpenAPIURLSession product in your specific target's dependencies.
```
// Add the package dependency
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),

// Add the product to your target
.target(name: "MyTarget", dependencies: [
    .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
]),
```
https://github.com/apple/swift-openapi-urlsession/blob/main/Sources/OpenAPIURLSession/Documentation.docc/Documentation.md
Install the URLSession Transport package
main
To use the URLSession transport with your generated Swift OpenAPI client, add swift-openapi-urlsession as a package dependency in your Package.swift file and include the OpenAPIURLSession product in your target's dependencies.
```
// Add the package dependency
.package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),

// Add the product to your target
.target(name: "MyTarget", dependencies: [
    .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
]),
```
https://github.com/apple/swift-openapi-urlsession/blob/main/README.md
Supported platforms and streaming limitations
main
The OpenAPIURLSession transport is compatible with the following platforms and minimum versions:
Platform Minimum Version
macOS 10.15+
iOS 13+
tvOS 13+
watchOS 6+
visionOS 1+
Linux ✅
Important Note on Streaming: Streaming support is only available on the following versions:
- macOS 12+
- iOS 15+
- tvOS 15+
- watchOS 8+
- visionOS 1+
For streaming support on Linux, use the AsyncHTTPClient Transport instead.
https://github.com/apple/swift-openapi-urlsession/blob/main/Sources/OpenAPIURLSession/Documentation.docc/Documentation.md
Supported platforms and streaming capabilities
main
The OpenAPIURLSession transport supports the following platforms:
Platform Minimum Version
macOS 10.15+
iOS 13+
tvOS 13+
watchOS 6+
visionOS 1+
Linux/Windows Supported
Important Note on Streaming: Streaming support is restricted to the following minimum versions:
- macOS 12+
- iOS 15+
- tvOS 15+
- watchOS 8+
- visionOS 1+
If you require streaming support on Linux, use the AsyncHTTPClient Transport instead.
https://github.com/apple/swift-openapi-urlsession/blob/main/README.md

Platform	Minimum Version
macOS	10.15+
iOS	13+
tvOS	13+
watchOS	6+
visionOS	1+
Linux/Windows	Supported