1 line
4.0 KiB
JSON
1 line
4.0 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(apiKey:)","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"apiKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"name":"apiKey","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A Marvel API key."}]}]}],"kind":"parameters"},{"content":[{"anchor":"discussion","text":"Discussion","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"The middleware attaches the required "},{"type":"codeVoice","code":"apikey"},{"type":"text","text":" parameter to the URI path of the intercepted request."},{"type":"text","text":" "},{"type":"text","text":"This initializer should be used for client-side applications, as indicated in the "},{"type":"reference","identifier":"https:\/\/developer.marvel.com\/documentation\/authorization","isActive":true}],"type":"paragraph"}],"kind":"content"}],"metadata":{"symbolKind":"init","externalID":"s:13MarvelService14AuthMiddlewareV6apiKeyACSS_tcfc","modules":[{"name":"MarvelService"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"apiKey"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":")"}],"title":"init(apiKey:)","role":"symbol","roleHeading":"Initializer"},"abstract":[{"text":"Initializes this middleware with an api key.","type":"text"}],"variants":[{"paths":["\/documentation\/marvelservice\/authmiddleware\/init(apikey:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/AuthMiddleware/init(apiKey:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware\/init(apiKey:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"apiKey","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":")","kind":"text"}],"url":"\/documentation\/marvelservice\/authmiddleware\/init(apikey:)","title":"init(apiKey:)","kind":"symbol","role":"symbol","abstract":[{"text":"Initializes this middleware with an api key.","type":"text"}]},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]},"https://developer.marvel.com/documentation/authorization":{"url":"https:\/\/developer.marvel.com\/documentation\/authorization","type":"link","title":"Marvel API documentation","titleInlineContent":[{"text":"Marvel API documentation","type":"text"}],"identifier":"https:\/\/developer.marvel.com\/documentation\/authorization"},"doc://MarvelService/documentation/MarvelService/AuthMiddleware":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/AuthMiddleware","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMiddleware","kind":"identifier"}],"url":"\/documentation\/marvelservice\/authmiddleware","title":"AuthMiddleware","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"abstract":[{"text":"A middleware that attaches the necessary authentication parameters to the path of the request.","type":"text"}]}}} |