Yaak Logo
Yaak
Feedback/Global Headers

Global Headers

Daniel E. Peterson·2 years ago
Needs TriageFeature Request

Ability to have global headers sent in every request inside a workspace.

Example: I know all endpoints to a certain host require a couple headers, e.g. a bypass-bot-protection flag or an API key. I'd like those to be automatically sent instead of needing to add to every request.

Values can be like other request fields - text or Environment variable.

Comments (4)

Sign in to leave a comment.

Ian.H

Seconded on this one. Being able to set this at a global level is pretty important for my workflow.

Just.Chola

I’d love to attempt building a plugin for this, but I have so much on my plate.
and i haven’t seen any documentation on what Yaak values are exposed to us for a plugin .
However Global Headers are a total must

Rob Cresswell

I’m curious how others are finding Yaak feasible to use without this feature. Is there something I’m missing? Even our small API has a couple dozen endpoints so far, and setting auth headers on each one is not something I’m going to tell my colleagues to do, as much as I’d love to recommend Yaak.

Konstantin Ilchenko

I was able to make a (very rough) proof of concept of plugin for this. Unfortunately it’s unrealistic to talk about publishing it, because the current state of plugins API just doesn’t have everything needed to at least achieve feature parity with corresponding plugin for Insomnia. Things that API is currently missing:

  • A more general plugin type for enriching/altering the request. In my PoC I use the `AuthenticationPlugin` type. It’s the only type which allows to alter request headers, but it wasn’t really designed for this, therefore some restrictions apply:

    • You have to specifically select “Global headers“ as the Auth mode. Moreover it has to be done per request

    • As a consequence of a previous bullet, you can’t combine Global headers with any other Auth mode.

  • There is no way to obtain the current workspace and/or its environment. Because of this, in the PoC I’ve just hardcoded the headers list

  • It’s pretty hard to debug the code. console.log doesn’t print anything in the inspector, `debugger;` statement doesn’t break – it seems like the process executing the plugin code is pretty well isolated

  • yaakcli codegen is lagging behind with dependencies, installing API typings of v0.2.x while the current version is 0.4.1

It works though. I may return to make a better version if/when the API has everything needed.

Leaving it here in case somebody wants to play:

import { 
    CallHttpAuthenticationRequest, 
    CallHttpAuthenticationResponse, 
    Context, 
    HttpHeader, 
    PluginDefinition,
} from '@yaakapp/api';

type Args = CallHttpAuthenticationRequest;
type GlobalHeaders = Promise<CallHttpAuthenticationResponse>;

const registry: { [key: string]: HttpHeader[] } = {
    default: [
        { name: 'x-test-header', value: 'default' },
    ],
    demo: [
        { name: 'x-test-header', value: 'overriden' },
    ]
}

export const plugin: PluginDefinition = {
    authentication: {
        name: 'global-headers',
        label: 'Global headers',
        shortLabel: 'Global headers',
        args: [{
            name: 'section',
            type: 'select',
            options: Object.keys(registry).map(x => ({ label: x, value: x })),
            optional: true,
            defaultValue: 'default',
        }],
        async onApply(ctx: Context, args: Args): GlobalHeaders {
            const headers = [
                ...registry['default'],
                ...(args.values.section === 'default' ? [] : registry[args.values.section as string]),
            ];
            
            return { setHeaders: headers };
        },
    },
};

If you want to run it:

  • generate a plugin with yaakcli generate,

  • update @yaakapp/api to at least v0.4.1

  • edit the registry variable

  • build it with yaakcli build (or yaakcli dev)

  • import the plugin to yaak

  • select “Global headers“ auth mode for your request and select a section (or leave the default one)

Type to search feedback...