1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"seeAlsoSections":[{"title":"Network","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiCompletion","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiEnvironment","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiError","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiModel","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiResult","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/HttpMethod"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiRoute"}],"languages":["swift"],"platforms":["iOS"]}]}],"variants":[{"paths":["\/documentation\/swiftkit\/apiroute"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute","interfaceLanguage":"swift"},"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."}],"kind":"symbol","metadata":{"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"ApiRoute"}],"title":"ApiRoute","roleHeading":"Protocol","role":"symbol","symbolKind":"protocol","externalID":"s:8SwiftKit8ApiRouteP","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"ApiRoute"}]},"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/path","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postData","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postParams","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postParamsData","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postParamsString","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/queryItems","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/queryParams"]},{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/formDataRequest(for:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/request(for:httpMethod:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/url(in:)"]}],"references":{"doc://SwiftKit/documentation/SwiftKit/ApiRoute/queryParams":{"role":"symbol","title":"queryParams","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"queryParams"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"The route’s optional query data dictionary, that should"},{"type":"text","text":" "},{"type":"text","text":"be added as a .utf8 encoded "},{"type":"codeVoice","code":"httpBody"},{"type":"text","text":" data string when"},{"type":"text","text":" "},{"type":"text","text":"performing a request."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/queryParams","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/apiroute\/queryparams"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute/postData":{"role":"symbol","title":"postData","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"postData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The route’s optional post data, that should be added as"},{"type":"text","text":" "},{"type":"codeVoice","code":"httpBody"},{"type":"text","text":" when performing a request. When defined, the"},{"type":"text","text":" "},{"type":"text","text":"property takes precedence over "},{"type":"codeVoice","code":"postParams"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postData","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/apiroute\/postdata"},"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/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/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/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"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute/postParamsString":{"role":"symbol","title":"postParamsString","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"postParamsString"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Convert the route "},{"type":"codeVoice","code":"formDataParams"},{"type":"text","text":" to a string that can"},{"type":"text","text":" "},{"type":"text","text":"be used in form data requests."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postParamsString","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiroute\/postparamsstring"},"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/ApiRoute/postParams":{"role":"symbol","title":"postParams","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"postParams"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"The route’s optional post data dictionary, which should"},{"type":"text","text":" "},{"type":"text","text":"be added as a .utf8 encoded "},{"type":"codeVoice","code":"httpBody"},{"type":"text","text":" data string when"},{"type":"text","text":" "},{"type":"text","text":"performing a request."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postParams","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/apiroute\/postparams"},"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/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/ApiRoute/formDataRequest(for:)":{"role":"symbol","title":"formDataRequest(for:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"formDataRequest"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ApiEnvironment","preciseIdentifier":"s:8SwiftKit14ApiEnvironmentP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"}],"abstract":[{"type":"text","text":"Create a "},{"type":"codeVoice","code":"URLRequest"},{"type":"text","text":" that is configured for being used"},{"type":"text","text":" "},{"type":"text","text":"with "},{"type":"codeVoice","code":"application\/x-www-form-urlencoded"},{"type":"text","text":" "},{"type":"codeVoice","code":"Content-Type"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/formDataRequest(for:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiroute\/formdatarequest(for:)"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute/queryItems":{"role":"symbol","title":"queryItems","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"queryItems"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"URLQueryItem","preciseIdentifier":"s:10Foundation12URLQueryItemV"},{"kind":"text","text":"]"}],"abstract":[{"type":"text","text":"The route’s query items, which are mapped "},{"type":"codeVoice","code":"queryParams"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/queryItems","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiroute\/queryitems"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute/request(for:httpMethod:)":{"role":"symbol","title":"request(for:httpMethod:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"request"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ApiEnvironment","preciseIdentifier":"s:8SwiftKit14ApiEnvironmentP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"httpMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"HttpMethod","preciseIdentifier":"s:8SwiftKit10HttpMethodO"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"}],"abstract":[{"type":"text","text":"This function returns a "},{"type":"codeVoice","code":"URLRequest"},{"type":"text","text":" that is configured"},{"type":"text","text":" "},{"type":"text","text":"for the given "},{"type":"codeVoice","code":"httpMethod"},{"type":"text","text":" and the route’s "},{"type":"codeVoice","code":"queryItems"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/request(for:httpMethod:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiroute\/request(for:httpmethod:)"},"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/documentation/SwiftKit/ApiRoute/url(in:)":{"role":"symbol","title":"url(in:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":"("},{"kind":"externalParam","text":"in"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"ApiEnvironment","preciseIdentifier":"s:8SwiftKit14ApiEnvironmentP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"abstract":[{"type":"text","text":"The route’s url in a certain api environment."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/url(in:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiroute\/url(in:)"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute/path":{"role":"symbol","title":"path","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The route’s environment-relative path, that is appended"},{"type":"text","text":" "},{"type":"text","text":"to the environment’s url when performing a request."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/path","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftkit\/apiroute\/path"},"doc://SwiftKit/documentation/SwiftKit/ApiRoute/postParamsData":{"role":"symbol","title":"postParamsData","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"postParamsData"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Convert the route "},{"type":"codeVoice","code":"formDataParams"},{"type":"text","text":" to "},{"type":"codeVoice","code":".utf8"},{"type":"text","text":" data that"},{"type":"text","text":" "},{"type":"text","text":"can be used in form data requests."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/postParamsData","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiroute\/postparamsdata"},"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"}}} |