https://github.com/apple/swift-nio-http2

HTTP/2 support for SwiftNIO
https://github.com/apple/swift-nio-http2

async beta http2 swift5 swiftnio

Last synced: about 1 month ago
JSON representation

HTTP/2 support for SwiftNIO

• Host: GitHub
• URL: https://github.com/apple/swift-nio-http2
• Owner: apple
• License: apache-2.0
• Created: 2018-03-03T02:20:22.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-01-22T13:28:27.000Z (10 months ago)
• Last Synced: 2024-01-27T23:40:55.607Z (10 months ago)
• Topics: async, beta, http2, swift5, swiftnio
• Language: Swift
• Homepage: https://swiftpackageindex.com/apple/swift-nio-http2/main/documentation/niohttp2
• Size: 3.6 MB
• Stars: 444
• Watchers: 36
• Forks: 83
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# SwiftNIO HTTP/2

This project contains HTTP/2 support for Swift projects using [SwiftNIO](https://github.com/apple/swift-nio). To get started, check the [API docs](https://swiftpackageindex.com/apple/swift-nio-http2/main/documentation/niohttp2).

## Building

`swift-nio-http2` is a SwiftPM project and can be built and tested very simply:

```bash

$ swift build

$ swift test

```

## Versions

Just like the rest of the SwiftNIO family, swift-nio-http2 follows [SemVer 2.0.0](https://semver.org/#semantic-versioning-200) with a separate document

declaring [SwiftNIO's Public API](https://github.com/apple/swift-nio/blob/main/docs/public-api.md).

### `swift-nio-http2` 1.x

`swift-nio-http2` versions 1.x are a pure-Swift implementation of the HTTP/2 protocol for SwiftNIO. It's part of the SwiftNIO 2 family of repositories and does not have any dependencies besides [`swift-nio`](https://github.com/apple/swift-nio) and Swift 5. As the latest version, it lives on the [`main`](https://github.com/apple/swift-nio-http2) branch.

To depend on `swift-nio-http2`, put the following in the `dependencies` of your `Package.swift`:

    .package(url: "https://github.com/apple/swift-nio-http2.git", from: "1.19.2"),

The most recent versions of SwiftNIO HTTP/2 support Swift 5.7 and newer. The minimum Swift version supported for SwiftNIO HTTP/2 releases are detailed below:

SwiftNIO HTTP/2     | Minimum Swift Version

--------------------|----------------------

`1.0.0 ..< 1.18.0`  | 5.0

`1.18.0 ..< 1.21.0` | 5.2

`1.21.0 ..< 1.23.0` | 5.4

`1.24.0 ..< 1.27.0` | 5.5.2

`1.27.0 ..< 1.29.0` | 5.6

`1.29.0 ..< 1.31.0` | 5.7

`1.31.0 ...`        | 5.8

### `swift-nio-http2` 0.x

The legacy `swift-nio-http` 0.x is part of the SwiftNIO 1 family of repositories and works on Swift 4.1 and newer but requires [nghttp2](https://nghttp2.org) to be installed on your system. The source code can be found on the [`nghttp2-support-branch`](https://github.com/apple/swift-nio-http2/tree/nghttp2-support-branch).

## Developing SwiftNIO HTTP/2

For the most part, SwiftNIO development is as straightforward as any other SwiftPM project. With that said, we do have a few processes that are worth understanding before you contribute. For details, please see [`CONTRIBUTING.md`](/CONTRIBUTING.md) in this repository.