# swift-openapi-urlsession

**Repository Path**: jerry8679/swift-openapi-urlsession

## Basic Information

- **Project Name**: swift-openapi-urlsession
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-29
- **Last Updated**: 2023-11-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# URLSession Transport for Swift OpenAPI Generator

[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/apple/swift-openapi-urlsession/documentation)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-openapi-urlsession%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/apple/swift-openapi-urlsession)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fapple%2Fswift-openapi-urlsession%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/apple/swift-openapi-urlsession)

A client transport that uses the [URLSession](https://developer.apple.com/documentation/foundation/urlsession) type from the [Foundation](https://developer.apple.com/documentation/foundation) framework 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 |
| :-:       | :-:   | :-:    | :-:    | :-:     |
| ✅ 10.15+ | ✅    | ✅ 13+ | ✅ 13+ | ✅ 6+   |

Note: Streaming support only available on macOS 12+, iOS 15+, tvOS 15+, and
watchOS 8+.For streaming support on Linux, please use the [AsyncHTTPClient
Transport](https://github.com/swift-server/swift-openapi-async-http-client)

## Usage

Add the package dependency in your `Package.swift`:

```swift
.package(
    url: "https://github.com/apple/swift-openapi-urlsession",
    exact: "1.0.0-alpha.1"
),
```

Note that this repository does not have a 1.0 tag yet, so the API is not stable.

Next, in your target, add `OpenAPIURLSession` to your dependencies:

```swift
.target(name: "MyTarget", dependencies: [
    .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
],
```

Then, to get started, check out `URLSessionTransport`.

## Reporting issues

Please report any issues related to this library in the
[swift-openapi-generator](https://github.com/apple/swift-openapi-generator/issues)
repository.

## Documentation

To learn more, check out the full [documentation](https://swiftpackageindex.com/apple/swift-openapi-urlsession/documentation).