rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity

Written the AmiiboService article for the documentation catalog.

Browse Source
This commit is contained in:
Javier Cicchelli 2023-04-25 00:36:48 +02:00
parent b27f830242
commit c1947efa96
1 changed files with 28 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Sources/AmiiboService.docc/AmiiboService.md
View File

@ -1,14 +1,37 @@
# ``AmiiboService`` # ``AmiiboService``
<!--@START_MENU_TOKEN@-->Summary<!--@END_MENU_TOKEN@--> Ready-to-use service that retrieves decoded entities from any of the [Amiibo API](https://www.amiiboapi.com) available endpoints.
## Overview ## Overview
<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@--> **AmiiboService** provides a service, filters and models for retrieving data from the remote [Amiibo API](https://www.amiiboapi.com) 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 ## Topics
### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@--> ### Essentials
- <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@--> - <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``