api

Documentation

Index

• func HelloHandler() http.HandlerFunc
• func ReadJSONBody(ctx context.Context, body io.ReadCloser, v interface{}, w http.ResponseWriter, ...) error
• func WriteJSONBody(ctx context.Context, v interface{}, w http.ResponseWriter, data log.Data) error
• type API
  • func Setup(ctx context.Context, cfg *config.Config, router *mux.Router, ...) *API
• type AuthHandler
• type MongoServer

Functions

func HelloHandler

func HelloHandler() http.HandlerFunc

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

func ReadJSONBody

func ReadJSONBody(ctx context.Context, body io.ReadCloser, v interface{}, w http.ResponseWriter, data log.Data) error

ReadJSONBody reads the bytes from the provided body, and marshals it to the provided model interface.

func WriteJSONBody

func WriteJSONBody(ctx context.Context, v interface{}, w http.ResponseWriter, data log.Data) error

WriteJSONBody marshals the provided interface into json, and writes it to the response body.

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, cfg *config.Config, router *mux.Router, dataStore store.DataStore, permissions AuthHandler) *API

Setup function sets up the api and returns an api

type AuthHandler

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

AuthHandler interface for adding auth to endpoints

type MongoServer

type MongoServer interface {
	Close(ctx context.Context) error
	Checker(ctx context.Context, state *healthcheck.CheckState) (err error)
	GetTopic(id string) (topic *models.TopicResponse, err error)
}

MongoServer defines the required methods from MongoDB