SwiftKit/data/documentation/swiftkit/apiroute/request(for:httpmethod:).json

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"request"},{"kind":"text","text":"("},{"kind":"externalParam","text":"for"},{"kind":"text","text":" "},{"kind":"internalParam","text":"env"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiEnvironment","preciseIdentifier":"s:8SwiftKit14ApiEnvironmentP","text":"ApiEnvironment"},{"kind":"text","text":", "},{"kind":"externalParam","text":"httpMethod"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/HttpMethod","preciseIdentifier":"s:8SwiftKit10HttpMethodO","text":"HttpMethod"},{"kind":"text","text":" = .get) -> "},{"kind":"typeIdentifier","text":"URLRequest","preciseIdentifier":"s:10Foundation10URLRequestV"}],"languages":["swift"],"platforms":["iOS"]}]}],"schemaVersion":{"major":0,"minor":2,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftkit\/apiroute\/request(for:httpmethod:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute\/request(for:httpMethod:)","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":"for the given "},{"type":"codeVoice","code":"httpMethod"},{"type":"text","text":" and the route’s "},{"type":"codeVoice","code":"queryItems"},{"type":"text","text":"."}],"kind":"symbol","metadata":{"role":"symbol","title":"request(for:httpMethod:)","roleHeading":"Instance Method","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"}],"symbolKind":"method","externalID":"s:8SwiftKit8ApiRoutePAAE7request3for10httpMethod10Foundation10URLRequestVAA0C11Environment_p_AA04HttpH0OtF","extendedModule":"SwiftKit","modules":[{"name":"SwiftKit"}]},"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit","doc:\/\/SwiftKit\/documentation\/SwiftKit\/ApiRoute"]]},"references":{"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/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":{"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/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/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:)"}}}