An open API service indexing awesome lists of open source software.

https://github.com/sobotics/swiftstack

A Swift wrapper for the Stack Exchange API
https://github.com/sobotics/swiftstack

api-wrapper stackexchange swift

Last synced: 6 months ago
JSON representation

A Swift wrapper for the Stack Exchange API

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/SOBotics/SwiftStack.svg?branch=master)](https://travis-ci.org/SOBotics/SwiftStack)

# About SwiftStack
SwiftStack is a wrapper for the Stack Exchange API written in Swift.

# How to use

To use SwiftStack via Swift Package Manager in your project, add it as dependency in your `Package.swift`.

```
let package = Package(
name: "MyProject",
dependencies: [
.Package(url: "https://github.com/NobodyNada/SwiftStack.git", versions: Version(0,0,0)..`. In this example, `T` is of type `Site`.

Of course, the functions can be more complex, when you want to pass parameters.

### Synchronous request

Synchronous requests return the result as `APIResponse` and `throw` errors. In this example, `T` is of type `Site`.

```
do {
let response = try client.fetchSites()
} catch {
print("An error occurred: \(error)")
}
```

Of course, the functions can be more complex, when you want to pass parameters.

## Returned objects

Every object that contains data of the Stack Exchange API (for example `User`, `Question`,...) has properties with the exact same names as returned by the API, even when those names don't follow Swift conventions.

## Documentation

The documentation can be found here: http://swiftstack.sobotics.org