Packages/auth/APIKey

Node: passportgithub.com/sahilkhaire/gox/auth

APIKey

Overview

APIKey validates a header API key and stores it on the request context.

Part of the auth package — Node.js analog: passport.

Signature

func APIKey(header string, opts APIKeyOpts) goxhttp.Middleware

Compare: Node.js · Standard Go · gox

Node.js

// Typical passport pattern in Node.js

Standard Go

// net/http middleware checking Authorization header

gox

import "github.com/sahilkhaire/gox/auth"

app.Use(auth.APIKey("X-API-Key", auth.APIKeyOpts{Keys: map[string]bool{"dev-key": true}}))

Example

import "github.com/sahilkhaire/gox/auth"

app.Use(auth.APIKey("X-API-Key", auth.APIKeyOpts{Keys: map[string]bool{"dev-key": true}}))

Tips

Import github.com/sahilkhaire/gox/auth and call APIKey directly. See the comparison below for the standard library equivalent.

Standard library alternative

gox wraps the Go standard library or a trusted dependency with Node-familiar naming. You can use the underlying library directly — see the package overview for escape hatches.

Related APIs

BasicBearerGetAPIKey

← Back to auth package overview