api

Documentation

Index

• func HelloHandler() http.HandlerFunc
• type API
  • func Setup(ctx context.Context, r *mux.Router, mongoDB MongoServer) *API
• type AuthHandler
• type HelloResponse
• type MongoServer

Functions

func HelloHandler

func HelloHandler() http.HandlerFunc

HelloHandler returns function containing a simple hello world example of an api handler

Types

type API

type API struct {
	Router *mux.Router
	// contains filtered or unexported fields
}

API provides a struct to wrap the api around

func Setup

func Setup(ctx context.Context, r *mux.Router, mongoDB MongoServer) *API

Setup function sets up the api and returns an api

type AuthHandler

type AuthHandler interface {
	Require(required dpauth.Permissions, handler http.HandlerFunc) http.HandlerFunc
}

AuthHandler interface for adding auth to endpoints

type HelloResponse

type HelloResponse struct {
	Message string `json:"message,omitempty"`
}

type MongoServer

type MongoServer interface {
	Close(ctx context.Context) error
	Checker(ctx context.Context, state *healthcheck.CheckState) (err error)
}

MongoServer defines the required methods from MongoDB