SwiftYNAB is a Swift framework for iOS/macOS/WatchOS/tvOS for accessing the You Need a Budget API. It currently supports all endpoints made available by the API.
You can browse the online documentation here to see what features this framework offers.
- Create a new project in Xcode
- Add a
Podfile
to the root directory of your project with the following contents:
use_frameworks!
target :'YourTargetName' do
pod 'SwiftYNAB', :git => 'https://github.com/andrebocchini/swiftynab.git'
end
- Run
pod install
You can also use the Swift Package Manager.
Instructions on how to add a Swift Package dependency to your project can be found here.
The project comes with a small iOS demo that shows you how to use the framework. If you want to try that out, or if you want to write your own code, you will need a personal API access token.
Make sure you go here and get one:
https://api.youneedabudget.com/#personal-access-tokens
Once you have your personal access token, you can use it to try out the framework in your app. Start by creating a new project and at the top of the file where you plan to use SwiftYNAB, add:
import SwiftYNAB
Then, you can try it out by writing something like:
let ynab = YNAB(accessToken: "TOKEN_GOES_HERE")
Task {
do {
let budgets = try await ynab.budgets.getBudgets()
for budget in budgets {
print(budget.name)
}
} catch {
print("Uh oh, something went wrong")
}
}