1 line
17 KiB
JSON
1 line
17 KiB
JSON
|
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService"},"sections":[],"primaryContentSections":[{"content":[{"anchor":"Overview","type":"heading","text":"Overview","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" library is a Swift Package Manager package dependency aims at allowing the developer to interact with the "},{"isActive":true,"type":"reference","identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" online service seamlessly, by not only providing the "},{"inlineContent":[{"text":"service","type":"text"}],"type":"emphasis"},{"type":"text","text":" tye but also any possible "},{"inlineContent":[{"text":"clients","type":"text"}],"type":"emphasis"},{"type":"text","text":", "},{"inlineContent":[{"text":"models","type":"text"}],"type":"emphasis"},{"type":"text","text":", "},{"inlineContent":[{"text":"filters","type":"text"}],"type":"emphasis"},{"type":"text","text":" and "},{"inlineContent":[{"text":"errors","type":"text"}],"type":"emphasis"},{"type":"text","text":" type that might be needed."}]},{"anchor":"Design","type":"heading","text":"Design","level":2},{"type":"paragraph","inlineContent":[{"type":"text","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, it was decided to design a "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service that removes the complexities of the service’s backend API, and provides the developer with a simple interface, and a seamless experience."}]},{"anchor":"Instalation","type":"heading","text":"Instalation","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"To use the "},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" library with your package, then add it as a dependency in the "},{"code":"Package.swift","type":"codeVoice"},{"type":"text","text":" file:"}]},{"code":["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"," ]",")"],"type":"codeListing","syntax":"swift"},{"type":"paragraph","inlineContent":[{"type":"text","text":"It is also possible to use the "},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" library with your app in Xcode, then add it as a dependency in your Xcode project:"}]},{"content":[{"inlineContent":[{"text":"Swift 5.9 or higher is required in order to compile this library.","type":"text"}],"type":"paragraph"}],"style":"important","type":"aside","name":"Important"}],"kind":"content"}],"metadata":{"title":"AmiiboService","symbolKind":"module","modules":[{"name":"AmiiboService"}],"roleHeading":"Framework","role":"collection","externalID":"AmiiboService"},"topicSections":[{"title":"Service","anchor":"Service","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"]},{"title":"Clients","anchor":"Clients","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"]},{"title":"Models","anchor":"Models","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Platform-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct","doc:\/\/AmiiboService\
|