api

Documentation

Index

• Constants
• 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

Constants

const (
	QuerySpotlightFlag int = 1 << iota // powers of 2, for combining bit flags

	// Publications:
	QueryArticlesFlag
	QueryBulletinsFlag
	QueryMethodologiesFlag
	QueryMethodologyArticlesFlag

	// Datasets:
	QueryStaticDatasetsFlag
	QueryTimeseriesFlag
)

Flag values for a query type:

Functions

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, topicAPIURL string) *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 provides authorisation checks on requests