Files

T

javier 37c0f3e322 DocC documentation support (#4 )

This PR contains the work done to:
* Documented all the `private`, `internal`, and `public` interfaces on the existing codebase;
* Set the DocC documentation catalog in the project;
* Written the main `Library` article for the DocC documentation catalog;
* Added the documentation tasks in the `Makefile` file.

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

2025-09-09 17:30:19 +00:00

2.0 KiB

Raw Blame History

`AmiiboService`

A library that provides everything the developer needs to interacts with the Amiibo API online service.

Overview

The AmiiboService library is a Swift Package Manager package dependency aims at allowing the developer to interact with the Amiibo API online service seamlessly, by not only providing the service tye but also any possible clients, models, filters and errors type that might be needed.

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, it was decided to design a AmiiboService service that removes the complexities of the service's backend API, and provides the developer with a simple interface, and a seamless experience.

Instalation

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.0.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.9 or higher is required in order to compile this library.

Topics

Service

AmiiboService

Clients

AmiiboClient
AmiiboLiveClient
AmiiboMockClient

Models

Amiibo
Amiibo/Game
Amiibo/Platform
Amiibo/Release
Amiibo/Usage
AmiiboSeries
AmiiboType
GameCharacter
GameSeries

Filters

AmiiboFilter
AmiiboSeriesFilter
AmiiboTypeFilter
GameCharacterFilter
GameSeriesFilter

Errors

AmiiboServiceError

2.0 KiB Raw Blame History

AmiiboService