https://github.com/0xwdg/simplenetworking
Simple networking is a Swift library for handling network requests. It is built on top of URLSession and provides a simple and easy-to-use interface for making network requests. the key features of SimpleNetworking are simple, mockable, reliable.
https://github.com/0xwdg/simplenetworking
0xwdg easy framework hacktoberfest networking simple simple-networking simplenetworking spm swift swiftlang
Last synced: 24 days ago
JSON representation
Simple networking is a Swift library for handling network requests. It is built on top of URLSession and provides a simple and easy-to-use interface for making network requests. the key features of SimpleNetworking are simple, mockable, reliable.
- Host: GitHub
- URL: https://github.com/0xwdg/simplenetworking
- Owner: 0xWDG
- License: mit
- Created: 2024-02-13T15:57:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-20T20:19:41.000Z (4 months ago)
- Last Synced: 2025-04-14T05:38:59.091Z (about 2 months ago)
- Topics: 0xwdg, easy, framework, hacktoberfest, networking, simple, simple-networking, simplenetworking, spm, swift, swiftlang
- Language: Swift
- Homepage: https://0xwdg.github.io/SimpleNetworking/
- Size: 437 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Simple Networking
This class is meant for simple network tasks.
[](https://swiftpackageindex.com/0xWDG/SimpleNetworking) [](https://swiftpackageindex.com/0xWDG/SimpleNetworking)
## Requirements
- Swift 5.9+ (Xcode 15+)
- iOS 13+, macOS 10.15+, tvOS, watchOS, Linux
## Installation
Install using Swift Package Manager
```swift
dependencies: [
.package(url: "https://github.com/0xWDG/SimpleNetworking.git", branch: "main"),
],
targets: [
.target(name: "MyTarget", dependencies: [
.product(name: "SimpleNetworking", package: "SimpleNetworking"),
]),
]
```
And import it:
```swift
import SimpleNetworking
```
## Usage
### Declare networking variable (preferred)
```swift
import SimpleNetworking
let networking = SimpleNetworking.shared
```
We use `networking` as the variable name, but you can use any name you like.
Please note in the examples below we use `networking` as the variable name.
If you use a different name, please replace `networking` with your variable name.
Or use `SimpleNetworking.shared` instead of `networking`.
### Setup (optional)
```swift
networking.set(serverURL: "https://wesleydegroot.nl")
```
### Set user-agent (optional)
```swift
networking.set(userAgent: "STRING")
```
### Set authentication (optional)
```swift
networking.set(authorization: "STRING")
```
### Set post type (optional)
```swift
networking.set(postType: .json) // .plain, .json, .graphQL
```
### GET data Async/Await
```swift
Task {
let response = await networking.request(
path: "/",
method: .get
)
print(response.string)
}
```
### POST data Async/Await
```swift
Task {
let response = await networking.request(
path: "/",
method: .post(
[
"postfield1": "poststring1",
"postfield2": "poststring2"
]
)
)
print(response.string)
}
```
### GET data (closure based)
```swift
networking.request(
path: "/",
method: .get
) { networkResponse in
print(networkResponse)
}
```
### POST data (closure based)
```swift
networking.request(
path: "/",
method: .post(
[
"postfield1": "poststring1",
"postfield2": "poststring2"
]
)
) { networkResponse in
print(networkResponse)
}
```
### networkResponse
With networkResponse you can get the following data:
- [response](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/response): URLResponse? // URLResponse
- [statuscode](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/statuscode): Int // HTTP status code
- [error](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/error): Error? // Error
- [data](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/data): Data? // Received data
- [string](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/string): String? // Received data as string
- [dictionary](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/dictionary): [String: Any]? // Received data as dictionary (only works if data is JSON)
- [cookies](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/cookies): [HTTPCookie]? // Received cookies
- [request](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/request): URLRequest? // Sent request
- [headers](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/headers): [HTTPHeader] // Received headers
- decoded -> T? // Decoded data
- [cURL](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/cURL): String // as cURL command
- [asHTTPRequest](https://0xwdg.github.io/SimpleNetworking/documentation/simplenetworking/simplenetworking/networkresponse/asHTTPRequest): String // as HTTP Request
### Bonus 1: JSON Decoding
#### Codable, decoding strategy = useDefaultKeys
```swift
struct MyCodable: Codable {
let value1: String
let value2: String
}
// Decode the response
let data: MyCodable? = networkResponse.decoded()
```
#### Codable, decoding strategy = convertFromSnakeCase
```swift
struct MyCodable: Codable {
let snakeCase: String
let caseSnake: String
}
// Decode the response
let data: MyCodable? = networkResponse.decoded(.convertFromSnakeCase)
```
### Bonus: Websocket
```swift
import SimpleNetworking
networking.connect(to: "https://api.github.com/users/0xWDG") { data in
print(data)
}
```
### Add HTTP Cookie
```swift
let cookie = HTTPCookie.init(properties: [
.name: "my cookie",
.value: "my value",
.domain: "wesleydegroot.nl"
.path: "/"
])
networking.add(cookie: cookie)
```
### Add HTTP Header
```swift
networking.add(header: .init(name: "my header", value: "my value"))
// Or if you want to declare it first
let header = SimpleNetworking.HTTPHeader(name: "my header", value: "my value")
networking.add(header: header)
```
### Mocking
SimpleNetworking can be mocked (since version 1.0.3), so you can test your code without actually making a network request.
```swift
networking.set(mockData: [
"https://wesleydegroot.nl": .init(
data: "OVERRIDE", // Can be Data or String
response: .init( // NSURLResponse, Can be nil
url: .init(string: "https://wesleydegroot.nl")!,
mimeType: "text/html",
expectedContentLength: 8,
textEncodingName: "utf-8"
),
statusCode: 200, // Int: If omitted, 200 is used
error: nil
),
"/only/an/path": .init(
data: "OVERRIDE", // Can be Data or String
response: .init( // NSURLResponse, Can be nil
url: .init(string: "https://wesleydegroot.nl/only/an/path")!,
mimeType: "text/html",
expectedContentLength: 8,
textEncodingName: "utf-8"
),
statusCode: 200, // Int: If omitted, 200 is used
error: nil
)
])
```
### Debugging
```swift
/// Debug: NSURLRequest
networking.debug.requestURL = false
/// Debug: sent HTTP Headers
networking.debug.requestHeaders = false
/// Debug: sent Cookies
networking.debug.requestCookies = false
/// Debug: sent Body
networking.debug.requestBody = false
/// Debug: received HTTP Headers
networking.debug.responseHeaders = false
/// Debug: received Body
networking.debug.responseBody = false
/// Debug: received JSON (if any)
networking.debug.responseJSON = false
```
## Contact
🦋 [@0xWDG](https://bsky.app/profile/0xWDG.bsky.social)
🐘 [mastodon.social/@0xWDG](https://mastodon.social/@0xWDG)
🐦 [@0xWDG](https://x.com/0xWDG)
🧵 [@0xWDG](https://www.threads.net/@0xWDG)
🌐 [wesleydegroot.nl](https://wesleydegroot.nl)
🤖 [Discord](https://discordapp.com/users/918438083861573692)
Interested learning more about Swift? [Check out my blog](https://wesleydegroot.nl/blog/).