Files
amiibo-service/README.md
T
javier 4623c13c24 Improved the Open API specification document (#19)
This PR contains the work done to improve the `OpenAPI` specification documentation that describes the `Amiibo API` online service as well as updates to the `AmiiboLiveClient` that uses the code generated out of the mentioned document. In addition, some test cases have been updated to reflect the latest data in the service.

Reviewed-on: #19
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-14 23:26:42 +00:00

1.5 KiB

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, then it is mandatory to 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.2.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 build this library.

Documentation

Please refer to the online documentation for further informations about this library.