javier
40afefed15
This PR contains the work done to: * improve the overall `OpenAPI` specification documentation describing the `Amiibo API` service; * update the `AmiiboFilter` type to include the `head` and `tail` properties; * update the error handling of the errors coming up from the service; * update its license to Apache v2.0; * regenerate the Github Pages documentation. Reviewed-on: #17 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
Amiibo Service
A library written entirely with Swift that provides everything the developer needs to interacts with the Amiibo API backend service.
Installation
To use this library with your package, then add it as a dependency in the Package.swift file:
let package = Package(
// name, platforms, products, etc.
dependencies: [
.package(url: "https://github.com/rock-n-code/amiibo-service", from: "1.0.0"),
// 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, then add it as a dependency in your Xcode project.
important: Swift 5.10 or higher is required in order to compile this library.
Documentation
Please refer to the online documentation for further informations about this library.