SwiftKit/data/documentation/swiftkit/apimodel.json

{"seeAlsoSections":[{"title":"Network","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiCompletion","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiEnvironment","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiError","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiResult","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/HttpMethod"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiModel"}],"title":"ApiModel","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:8SwiftKit8ApiModelP","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"ApiModel"}]},"abstract":[{"type":"text","text":"This protocol can be implemented by any api models that can"},{"type":"text","text":" "},{"type":"text","text":"be fetched from an api and converted to a local model."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/Se"],"kind":"relationships","title":"Inherits From","type":"inheritsFrom"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Associated Types","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel\/LocalModel"]},{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel\/convert()"]}],"variants":[{"paths":["\/documentation\/swiftkit\/apimodel"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiModel"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Decodable","preciseIdentifier":"s:Se"}],"languages":["swift"],"platforms":["iOS"]}]},{"kind":"content","content":[{"anchor":"overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Use this protocol to enforce separating api models from the"},{"type":"text","text":" "},{"type":"text","text":"models used in your apps."}]}]}],"references":{"doc://SwiftKit/documentation/SwiftKit/ApiCompletion":{"role":"symbol","title":"ApiCompletion","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiCompletion"}],"abstract":[{"type":"text","text":"This completion type is used by the "},{"type":"codeVoice","code":"ApiService"},{"type":"text","text":" protocol."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiCompletion","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiCompletion"}],"url":"\/documentation\/swiftkit\/apicompletion"},"doc://SwiftKit/documentation/SwiftKit/ApiModel/LocalModel":{"role":"symbol","title":"LocalModel","fragments":[{"kind":"keyword","text":"associatedtype"},{"kind":"text","text":" "},{"kind":"identifier","text":"LocalModel"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel\/LocalModel","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/apimodel\/localmodel"},"doc://SwiftKit/documentation/SwiftKit/HttpMethod":{"role":"symbol","title":"HttpMethod","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"HttpMethod"}],"abstract":[{"type":"text","text":"This enum lists the various HTTP methods that are supported"},{"type":"text","text":" "},{"type":"text","text":"by REST."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/HttpMethod","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"HttpMethod"}],"url":"\/documentation\/swiftkit\/httpmethod"},"doc://SwiftKit/documentation/SwiftKit":{"role":"collection","title":"SwiftKit","abstract":[{"type":"text","text":"SwiftKit adds extra functionality to the Swift framework, like extensions to native types, utilites, services etc."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit"},"doc://SwiftKit/documentation/SwiftKit/ApiError":{"role":"symbol","title":"ApiError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiError"}],"abstract":[{"type":"text","text":"This enum contains errors that can occur when communicating"},{"type":"text","text":" "},{"type":"text","text":"with an api, using an "},{"type":"codeVoice","code":"ApiService"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiError"}],"url":"\/documentation\/swiftkit\/apierror"},"doc://SwiftKit/documentation/SwiftKit/ApiService":{"role":"symbol","title":"ApiService","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiService"}],"abstract":[{"type":"text","text":"This protocol can be implemented by any service that can be"},{"type":"text","text":" "},{"type":"text","text":"used to communicate with an external api."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiService"}],"url":"\/documentation\/swiftkit\/apiservice"},"doc://SwiftKit/documentation/SwiftKit/ApiModel":{"role":"symbol","title":"ApiModel","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiModel"}],"abstract":[{"type":"text","text":"This protocol can be implemented by any api models that can"},{"type":"text","text":" "},{"type":"text","text":"be fetched from an api and converted to a local model."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiModel"}],"url":"\/documentation\/swiftkit\/apimodel"},"doc://SwiftKit/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/SwiftKit\/Se"},"doc://SwiftKit/documentation/SwiftKit/ApiEnvironment":{"role":"symbol","title":"ApiEnvironment","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiEnvironment"}],"abstract":[{"type":"text","text":"This protocol represents an external api environment with a"},{"type":"text","text":" "},{"type":"text","text":"specific root "},{"type":"codeVoice","code":"url"},{"type":"text","text":", e.g. test, staging or production."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiEnvironment","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiEnvironment"}],"url":"\/documentation\/swiftkit\/apienvironment"},"doc://SwiftKit/documentation/SwiftKit/ApiModel/convert()":{"role":"symbol","title":"convert()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"convert"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"LocalModel","preciseIdentifier":"s:8SwiftKit8ApiModelP05LocalD0Qa"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel\/convert()","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/apimodel\/convert()"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute":{"role":"symbol","title":"ApiRoute","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiRoute"}],"abstract":[{"type":"text","text":"This protocol represents an external api route, e.g. "},{"type":"codeVoice","code":"login"},{"type":"text","text":" "},{"type":"text","text":"or "},{"type":"codeVoice","code":"user"},{"type":"text","text":". Each route is a separate action that defines all"},{"type":"text","text":" "},{"type":"text","text":"information required to perform an api request."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiRoute"}],"url":"\/documentation\/swiftkit\/apiroute"},"doc://SwiftKit/documentation/SwiftKit/ApiResult":{"role":"symbol","title":"ApiResult","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiResult"}],"abstract":[{"type":"text","text":"This result type is used by the "},{"type":"codeVoice","code":"ApiCompletion"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiResult","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"ApiResult"}],"url":"\/documentation\/swiftkit\/apiresult"}}}