api

README

Golang Simple API

Golang Simple API is small library to enable simple Authenticated API calls

Install

go get go.ideatocode.tech/api

Import

import api "go.ideatocode.tech/api"

Example

Check the examples dir for a complete working example# go-simpleapi-builder

Documentation

Index

• Constants
• type AuthCallback
• type Controller
  • func NewController(list ...SetOptFunc) *Controller
  • func (c *Controller) AddHandler(path string, fn HTTPHandler, methods ...string)
  • func (c *Controller) Addr() net.Addr
  • func (c *Controller) Run(addr string) error
  • func (c *Controller) Stop()
• type HTTPHandler
• type SetOptFunc
  • func WithAnonymousRequests() SetOptFunc

Constants

const (
	// KeyAuthID returns the context Value of the Auth set by the defaultAuthMiddleware func on successful auth
	KeyAuthID key = iota
)

Types

type AuthCallback

type AuthCallback func(token string, req *http.Request) (payload interface{}, err error)

AuthCallback is the function called when doing bearer authentication

type Controller

type Controller struct {
	AuthCallback AuthCallback
	// contains filtered or unexported fields
}

Controller runs the controller

func NewController

func NewController(list ...SetOptFunc) *Controller

NewController creates a new HTTP API controller

func (*Controller) AddHandler

func (c *Controller) AddHandler(path string, fn HTTPHandler, methods ...string)

AddHandler adds a handler

func (*Controller) Addr

func (c *Controller) Addr() net.Addr

Addr returns the underlying net.Addr that this server listens on

func (*Controller) Run

func (c *Controller) Run(addr string) error

Run runs the controller and the listener

func (*Controller) Stop

func (c *Controller) Stop()

Stop stops the http listener

type HTTPHandler

type HTTPHandler func(w http.ResponseWriter, r *http.Request)

HTTPHandler is the handler that is called when path is accessed

type SetOptFunc

type SetOptFunc func(*Controller)

func WithAnonymousRequests

func WithAnonymousRequests() SetOptFunc

WithAnonymousRequests allows requests with no auth headers through to the auth middleware