rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity
amiibo-service/Sources/AmiiboService.docc/AmiiboService.md
Javier Cicchelli 6ba137a482 [Enhancement] Linux platform support (#17) 
This PR contains the work done to provide full support of this package to Linux platform, by removing the restriction on the `AmiiboClient` client and the `AmiiboService` service put in place on the `v1.0.1` release.

To provide further details about the work done:
- [x] updated the `SwiftLibs` package dependency to `v0.1.7`;
- [x] made the `AmiiboClient` client and the `AmiiboService` service available to Linux platforms by importing the `FoundationNetworking` framework when available;
- [x] updated the content of some DocC documentation pages;
- [x] regenerated the Xcode and Github pages documentation;
- [x] updated some text in the `README` file.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #17
2023-04-30 13:59:37 +00:00

1.2 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 not only Apple platforms, such as iOS, macOS, tvOS, and watchOS, but also Linux. 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

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