Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uhooi/swift-http-client
Communicate via HTTP easily in Swift.
https://github.com/uhooi/swift-http-client
http http-client ios linux swift
Last synced: about 2 months ago
JSON representation
Communicate via HTTP easily in Swift.
- Host: GitHub
- URL: https://github.com/uhooi/swift-http-client
- Owner: uhooi
- License: mit
- Created: 2021-07-31T11:52:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-02T12:56:20.000Z (over 2 years ago)
- Last Synced: 2024-10-30T17:18:36.519Z (about 2 months ago)
- Topics: http, http-client, ios, linux, swift
- Language: Swift
- Homepage:
- Size: 62.5 KB
- Stars: 15
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - swift-http-client
README
# swift-http-client
[](https://github.com/uhooi/swift-http-client/actions/workflows/main.yml)
[](https://github.com/uhooi/swift-http-client/releases/latest)
[](https://cocoapods.org/pods/UHIHTTPClient)
[](https://github.com/uhooi/swift-http-client)
[](https://swiftpackageindex.com/uhooi/swift-http-client)
[](https://swiftpackageindex.com/uhooi/swift-http-client)
[](https://github.com/uhooi/swift-http-client/blob/main/LICENSE)
[](https://twitter.com/the_uhooi)
Communicate via HTTP easily in Swift.
## Table of Contents
- [System requirements](#system-requirements)
- [Installation](#installation)
- [How to use](#how-to-use)
- [Contribution](#contribution)
- [Stats](#stats)
## System requirements
- Swift: 5.5+
- Xcode: 13.0+
- macOS: 11.3+
## Installation
### Swift Package Manager (Recommended)
#### Package
You can add this package to `Package.swift`, include it in your target dependencies.
```swift
let package = Package(
dependencies: [
.package(url: "https://github.com/uhooi/swift-http-client", .upToNextMajor(from: "0.6.0")),
],
targets: [
.target(
name: "",
dependencies: ["HTTPClient"]),
]
)
```
#### Xcode
You can add this package on Xcode.
See [documentation](https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app).
### CocoaPods
This library is available through [CocoaPods](https://cocoapods.org). To install it, simply add the following line to your `Podfile`:
```ruby
pod 'UHIHTTPClient', '~> 0.6.0'
```
### Carthage
This library is available through [Carthage](https://github.com/Carthage/Carthage). To install it, simply add the following line to your `Cartfile`:
```
github "uhooi/swift-http-client" ~> 0.6.0
```
## How to use
You can just import `HTTPClient` to use it.
1. Implement a request body structure that conforms to the `Encodable` protocol. (Optional)
```swift
struct RegisterUserRequestBody: Encodable {
let name: String
let description: String
}
```
2. Implement a response body structure that conforms to the `Decodable` protocol.
```swift
struct RegisterUserResponseBody: Decodable {
let id: String
}
extension RegisterUserResponseBody {
func convertToUserID() -> UserID { .init(id: self.id) }
}
```
3. Implement a request structure that conforms to the `Request` protocol.
```swift
import HTTPClient
struct RegisterUserRequest: Request {
typealias ResponseBody = RegisterUserResponseBody
var path: String { "user/create_user" }
var httpMethod: HTTPMethod { .post }
var httpHeaders: [HTTPHeaderField: String]? { [.contentType: ContentType.applicationJson.rawValue] }
}
```
4. Create an instance of the `HTTPClient` class and call the `request` method.
```swift
struct UserID: Identifiable, Equatable {
let id: String
}
```
```swift
protocol VersatileRepository {
func registerUser(name: String, description: String) async throws -> UserID
}
```
```swift
import HTTPClient
final class VersatileAPIClient {
static let shared = VersatileAPIClient()
private let httpClient = HTTPClient(baseURLString: "https://example.com/api/")
}
extension VersatileAPIClient: VersatileRepository {
func registerUser(name: String, description: String) async throws -> UserID {
let requestBody = RegisterUserRequestBody(name: name, description: description)
let responseBody = try await httpClient.request(RegisterUserRequest(), requestBody: requestBody)
return responseBody.convertToUserID()
}
}
```
```swift
do {
let userID = try await VersatileAPIClient.shared.registerUser(name: "Uhooi", description: "Green monster.")
// Do something.
} catch {
// Do error handling.
print(error)
}
```
## Contribution
I would be happy if you contribute :)
- [New issue](https://github.com/uhooi/swift-http-client/issues/new)
- [New pull request](https://github.com/uhooi/swift-http-client/compare)
## Stats
[](https://github.com/uhooi/swift-http-client)