SwiftKit/data/documentation/swiftkit/apiservice/formdatarequest(for:).json

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"formDataRequest"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":" "},{"kind":"internalParam","text":"route"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute","preciseIdentifier":"s:8SwiftKit8ApiRouteP","text":"ApiRoute"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftkit\/apiservice\/formdatarequest(for:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiService\/formDataRequest(for:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"This function returns a "},{"type":"codeVoice","code":"URLRequest"},{"type":"text","text":" that is configured"},{"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":" "},{"type":"text","text":"and the query params of the route applied as "},{"type":"codeVoice","code":"httpBody"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"using "},{"type":"codeVoice","code":"POST"},{"type":"text","text":" as "},{"type":"codeVoice","code":"httpMethod"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"formDataRequest(for:)","roleHeading":"Instance Method","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":"ApiRoute","preciseIdentifier":"s:8SwiftKit8ApiRouteP"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"}],"symbolKind":"method","externalID":"s:8SwiftKit10ApiServicePAAE15formDataRequest3for10Foundation10URLRequestVAA0C5Route_p_tF","extendedModule":"SwiftKit","modules":[{"name":"SwiftKit"}]},"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiService"]]},"references":{"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/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/ApiService/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":"ApiRoute","preciseIdentifier":"s:8SwiftKit8ApiRouteP"},{"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":"with "},{"type":"codeVoice","code":"application\/x-www-form-urlencoded"},{"type":"text","text":" "},{"type":"codeVoice","code":"Content-Type"},{"type":"text","text":" "},{"type":"text","text":"and the query params of the route applied as "},{"type":"codeVoice","code":"httpBody"},{"type":"text","text":","},{"type":"text","text":" "},{"type":"text","text":"using "},{"type":"codeVoice","code":"POST"},{"type":"text","text":" as "},{"type":"codeVoice","code":"httpMethod"},{"type":"text","text":"."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiService\/formDataRequest(for:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/apiservice\/formdatarequest(for:)"}}}