1 line
14 KiB
JSON
1 line
14 KiB
JSON
{"abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"inlineContent":[{"text":"Amiibo API","type":"text"}],"type":"strong"},{"text":" backend service.","type":"text"}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"content","content":[{"level":2,"anchor":"Overview","text":"Overview","type":"heading"},{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"amiibo-service"},{"text":" library is a package that allows the developer to interact with the ","type":"text"},{"type":"reference","identifier":"https:\/\/www.amiiboapi.com","isActive":true},{"text":" backend service seamlessly, by not only providing the ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"service"}]},{"text":" type but also any possible ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"models"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"text":"filters","type":"text"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"errors"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"interfaces","type":"text"}]},{"type":"text","text":" types that might be needed during implementation."}],"type":"paragraph"},{"level":2,"anchor":"Design","text":"Design","type":"heading"},{"inlineContent":[{"text":"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 ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" 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."}],"type":"paragraph"},{"anchor":"Installation","type":"heading","text":"Installation","level":2},{"type":"paragraph","inlineContent":[{"text":"To use the ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"text":" library with your package, then add it as a dependency in the ","type":"text"},{"code":"Package.swift","type":"codeVoice"},{"text":" file:","type":"text"}]},{"type":"codeListing","syntax":"swift","code":["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"," ]",")"]},{"type":"paragraph","inlineContent":[{"text":"It is also possible to use the ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"text":" library with your app in Xcode, then add it as a dependency in your Xcode project.","type":"text"}]},{"name":"Important","style":"important","content":[{"type":"paragraph","inlineContent":[{"text":"Swift 5.10 or higher is required in order to compile this library.","type":"text"}]}],"type":"aside"},{"level":2,"text":"Tasks","anchor":"Tasks","type":"heading"},{"inlineContent":[{"text":"This library offers a set of ready-to-use tasks that simplify the interaction with the library, which the developer can use from any ","type":"text"},{"type":"codeVoice","code":"Terminal"},{"type":"text","text":" application."}],"type":"paragraph"},{"style":"tip","name":"Tip","type":"aside","content":[{"inlineContent":[{"text":"To show the available list of tasks, plus display some explanations about each and every one of them; please enter the following command:","type":"text"}],"type":"paragraph"}]},{"type":"codeListing","syntax":"bash","code":["$ make"]}]}],"hierarchy":{"paths":[[]]},"sections":[],"kind":"symbol","metadata":{"externalID":"AmiiboService","roleHeading":"Framework","title":"AmiiboService","modules":[{"name":"AmiiboService"}],"symbolKind":"module","role":"collection"},"topicSections":[{"anchor":"Service","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"],"title":"Service"},{"anchor":"Clients","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"],"title":"Clients"},{"anchor":"Models","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"],"title":"Models"},{"anchor":"Filters","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter"],"title":"Filters"},{"anchor":"Errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"],"title":"Errors"}],"variants":[{"paths":["\/documentation\/amiiboservice"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"abstract":[{"type":"text","text":"A model that represents an amiibo series."}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeries"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","url":"\/documentation\/amiiboservice\/amiiboseries","title":"AmiiboSeries","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameSeriesFilter":{"kind":"symbol","url":"\/documentation\/amiiboservice\/gameseriesfilter","title":"GameSeriesFilter","abstract":[{"text":"A type that contains values to fine-tune a response when requesting game series.","type":"text"}],"navigatorTitle":[{"text":"GameSeriesFilter","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeriesFilter","kind":"identifier"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"kind":"symbol","role":"collection","title":"AmiiboService","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"inlineContent":[{"text":"Amiibo API","type":"text"}],"type":"strong"},{"type":"text","text":" backend service."}],"type":"topic","url":"\/documentation\/amiiboservice","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","title":"AmiiboClient","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"role":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboclient","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboTypeFilter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","title":"AmiiboTypeFilter","type":"topic","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo types."}],"kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboTypeFilter"}],"url":"\/documentation\/amiiboservice\/amiibotypefilter","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboTypeFilter"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"abstract":[{"type":"text","text":"A type that implements the service that uses a client to make calls."}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboService"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","title":"AmiiboService","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"abstract":[{"type":"text","text":"A model that represents a game character."}],"title":"GameCharacter","url":"\/documentation\/amiiboservice\/gamecharacter","type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"GameCharacter","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"GameCharacter"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"abstract":[{"type":"text","text":"A model that represents an amiibo."}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Amiibo","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","url":"\/documentation\/amiiboservice\/amiibo","title":"Amiibo","navigatorTitle":[{"text":"Amiibo","kind":"identifier"}],"kind":"symbol","role":"symbol"},"https://www.amiiboapi.com":{"type":"link","title":"Amiibo API","identifier":"https:\/\/www.amiiboapi.com","url":"https:\/\/www.amiiboapi.com","titleInlineContent":[{"type":"text","text":"Amiibo API"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo items.","type":"text"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","url":"\/documentation\/amiiboservice\/amiibofilter","title":"AmiiboFilter","navigatorTitle":[{"text":"AmiiboFilter","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeriesFilter":{"abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo series.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeriesFilter"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","url":"\/documentation\/amiiboservice\/amiiboseriesfilter","title":"AmiiboSeriesFilter","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeriesFilter"}],"kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","title":"AmiiboType","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboType"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}],"abstract":[{"type":"text","text":"A model that represents an amiibo type."}],"role":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibotype","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"abstract":[{"text":"A model that represents a game series.","type":"text"}],"title":"GameSeries","url":"\/documentation\/amiiboservice\/gameseries","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeries","kind":"identifier"}],"kind":"symbol","navigatorTitle":[{"text":"GameSeries","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","title":"AmiiboLiveClient","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"role":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","role":"symbol","type":"topic","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","type":"reference","isActive":true},{"text":" service could throw.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"AmiiboServiceError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameCharacterFilter":{"abstract":[{"text":"A type that contains values to fine-tune a response when requesting game characters.","type":"text"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameCharacterFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","url":"\/documentation\/amiiboservice\/gamecharacterfilter","title":"GameCharacterFilter","navigatorTitle":[{"text":"GameCharacterFilter","kind":"identifier"}],"kind":"symbol","role":"symbol"}}} |