Files

T

javier 0d9c9e22a4 Open API and documentation improvements (#20 )

This PR contains the work done to polish the `Open API` specification document as well as the `DocC` documentation even further, by removing unnecessary intermediate types and adding missing documentation.

Reviewed-on: #20
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>

2025-10-28 15:41:02 +00:00

2.3 KiB

Raw Blame History

`AmiiboService`

A library that provides everything the developer needs to interact with the Amiibo API backend service.

Overview

The amiibo-service library is a package that allows the developer to interact with the Amiibo API backend service seamlessly, by not only providing the service type but also any possible models, filters, errors and interfaces types that might be needed during implementation.

Design

Although it could have been possible to generate a one-to-one RESTful client based on the Open API specification document that describe the available endpoints of the backend service, it was decided to design a AmiiboService service type that removes the complexities of the API design imposed by the backend service, and provides the developer with a simple interface, and a seamless experience.

Installation

To use the AmiiboService 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.2.0"),
        // other dependencies
    ],
    targets: [
        .target(
            name: "SomeTarget", 
            dependencies: [
                .product(name: "AmiiboService", package: "amiibo-service"),
            ]
        )
        // other targets
    ]
)

It is also possible to use the AmiiboService 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.

Tasks

This library offers a set of ready-to-use tasks that simplify the interaction with the library, which the developer can use from any Terminal application.

Tip: To show the available list of tasks, plus display some explanations about each and every one of them; please enter the following command:

$ make

Topics

Service

AmiiboService

Clients

AmiiboClient
AmiiboLiveClient

Models

Amiibo
AmiiboSeries
AmiiboType
GameCharacter
GameSeries

Filters

AmiiboFilter
AmiiboSeriesFilter
AmiiboTypeFilter
GameCharacterFilter
GameSeriesFilter

Errors

AmiiboServiceError

2.3 KiB Raw Blame History

AmiiboService