Javier Cicchelli 36eecc15fb [Tweaks] DocC documentation (#15 )

This PR contains the work done to address the issue #14, that recommends some tweaks to the generated documentation targeting Xcode and Github pages.

To provide further details about the work done:
- [x] written the *Getting Started* article in the documentation catalog;
- [x] written the *AmiiboService* article in the documentation catalog;
- [x] updated the text of the `README` file;
- [x] downgraded the Swift tool version in the `Package` file to v5.5;
- [x] added the missing header file to the `Package` file;
- [x] updated the `SwiftLibs` package dependency to its latest release;
- [x] re-generated the documentation targeting Xcode and Github pages.

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

2023-04-25 14:29:23 +00:00

1.1 KiB

Raw Blame History

`AmiiboService`

Ready-to-use service that retrieves decoded entities from any of the Amiibo API available endpoints.

Overview

AmiiboService provides a service, filters and models for retrieving data from the remote Amiibo API endpoints to use in libraries and applications targeting Apple platforms, such as iOS, macOS, tvOS, and watchOS. This package provides structures that can be used to include filters to the requests to send to the remote service if required. In addition, the structures to model the kinds of data coming in from those responses into entities are also provided.

Topics

Essentials

doc:GettingStarted
AmiiboService/AmiiboService

Filter data when making requests

AmiiboFilter
KeyNameFilter
AmiiboSeriesFilter
AmiiboTypeFilter
CharacterFilter
GameSeriesFilter

Models to decode the data coming from the responses

Amiibo
KeyName
AmiiboSeries
AmiiboType
Character
GameSeries
LastUpdated

Errors that can be thrown by the service

AmiiboClientError

1.1 KiB Raw Blame History

AmiiboService