Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eneko/jab
Jab is a Swift 3 library that does synchronous HTTP JSON requests
https://github.com/eneko/jab
json network swift
Last synced: 6 days ago
JSON representation
Jab is a Swift 3 library that does synchronous HTTP JSON requests
- Host: GitHub
- URL: https://github.com/eneko/jab
- Owner: eneko
- License: mit
- Created: 2016-11-27T03:29:06.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-27T08:18:11.000Z (about 8 years ago)
- Last Synced: 2024-12-16T22:16:36.609Z (about 1 month ago)
- Topics: json, network, swift
- Language: Swift
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jab
Jab is a Swift 3 library that does synchronous HTTP __JSON__ requests
Many iOS, command line or server side applications rely on getting or sending
JSON from/to some remote server on Internet or local network.
Jab is a tiny library that handles those JSON network requests for you,
including serialization of payloads (anything serializable by JSONSerialization)
and deserialization of responses.
## Simple requests without Futures, Promises or Callback blocks
```swift
let clients = try Jab().get(url: "http://example.com/clients")
```
```swift
let newClient: [String, Any] = [
"first_name": "Jon",
"last_name": "Doe",
"age": 31
]
try Jab().post(url: "http://example.com/clients", payload: newClient)
```
## Sequential requests
```swift
let bob = try Jab().get(url: "http://example.com/clients/bob")
let alice = try Jab().get(url: "http://example.com/clients/alice")
let janey = try Jab().get(url: "http://example.com/clients/janey")
return [bob, alice, janey]
```
Synchronous network requests are great for many reasons:
- Simplify business logic
- Allow for natural chaining of operations
- Delegate control of UI workflows to your application UI layer.
See more working sample requests in our [Integration Tests](/Tests/IntegrationTests.swift).
## Error handling
Jab uses [Swift exception based error handling](https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/ErrorHandling.html).
The following are all errors thrown by Jab if something bad happens:
```swift
public enum JabError: Error {
case offline
case invalidRequest
case serialization
case deserialization
case noResponse
case requestFailed(error: Error)
}
```
## Mind your application user interface
If you are using Jab in an application with a graphic user interface, make sure
to run any requests in a background thread with the proper QoS priority:
```swift
override func viewDidLoad() {
super.viewDidLoad()
DispatchQueue.global(qos: .userInitiated).async { [weak self] in
do {
self?.clients = try Jab().get(url: "http://example.com/clients.json")
} catch {
// Handle errors accordingly
self.clients = nil
}
DispatchQueue.main.async {
self?.tableView.reloadData()
}
}
```