https://github.com/rock-n-code/amiibo-service
An unofficial service written in Swift that interacts with the Amiibo API backend service.
https://github.com/rock-n-code/amiibo-service
amiibo-api amiibos swift-client swift-library
Last synced: 2 months ago
JSON representation
An unofficial service written in Swift that interacts with the Amiibo API backend service.
- Host: GitHub
- URL: https://github.com/rock-n-code/amiibo-service
- Owner: rock-n-code
- License: apache-2.0
- Created: 2025-09-16T16:03:50.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2026-03-23T00:20:38.000Z (2 months ago)
- Last Synced: 2026-03-23T18:12:32.635Z (2 months ago)
- Topics: amiibo-api, amiibos, swift-client, swift-library
- Language: Swift
- Homepage: https://rock-n-code.github.io/amiibo-service/documentation/amiiboservice/
- Size: 1.58 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
[](https://swiftpackageindex.com/rock-n-code/amiibo-service)
[](https://swiftpackageindex.com/rock-n-code/amiibo-service)
# Amiibo Service
A library written entirely with [Swift](https://www.swift.org) that provides everything the developer needs to interact with the [Amiibo API](https://www.amiiboapi.org) backend service.
## Installation
To use this library, add it as a dependency in the `Package.swift` file:
```swift
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/rock-n-code/amiibo-service", from: "1.4.1"),
// other dependencies
],
targets: [
.target(
name: "SomeTarget",
dependencies: [
.product(name: "AmiiboService", package: "amiibo-service"),
]
)
// other targets
]
)
```
It is also possible to use this library with your app in Xcode by adding it as a dependency in your Xcode project.
> [!IMPORTANT]
> Swift 5.10 or higher is required in order to build this library.
## Usage
```swift
import AmiiboService
let service = AmiiboService()
// Fetch all amiibos
let amiibos = try await service.getAmiibos()
// Fetch amiibos filtered by name
let zeldaAmiibos = try await service.getAmiibos(.init(name: "zelda"))
// Fetch amiibo series, types, game characters, and game series
let series = try await service.getAmiiboSeries()
let types = try await service.getAmiiboTypes()
let characters = try await service.getGameCharacters()
let gameSeries = try await service.getGameSeries()
// Fetch the last updated timestamp
let lastUpdated = try await service.getLastUpdated()
```
## Caching
The [Amiibo API](https://www.amiiboapi.org) recommends that consumers who call the API regularly implement caching on their systems. Pass a custom `URLSessionTransport` with a cache-configured `URLSession` to `AmiiboLiveClient`:
```swift
import OpenAPIURLSession
let configuration = URLSessionConfiguration.default
configuration.urlCache = URLCache(
memoryCapacity: 5_000_000,
diskCapacity: 50_000_000
)
let transport = URLSessionTransport(
configuration: .init(
session: URLSession(configuration: configuration)
)
)
let service = AmiiboService(
client: AmiiboLiveClient(transport: transport)
)
```
## Testing
The `AmiiboClient` protocol enables creating custom mock clients for unit testing without network calls. Conform to `AmiiboClient` and inject it into `AmiiboService` via its `init(client:)` initializer:
```swift
import AmiiboService
struct MyMockClient: AmiiboClient {
var error: AmiiboServiceError?
func getAmiibos(
by filter: AmiiboFilter
) async throws(AmiiboServiceError) -> [Amiibo] {
if let error { throw error }
return []
}
// Implement remaining protocol requirements...
}
let service = AmiiboService(client: MyMockClient())
```
## Documentation
Please refer to the [online documentation](https://rock-n-code.github.io/amiibo-service/documentation/amiiboservice/) for further information about this library.