handlers

Documentation

Overview

Package classification of Product API

Documentation for Product API

Schemes: http
BasePath: /
Version: 1.0.0

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Index

• Variables
• type GenericError
• type KeyProduct
• type Products
  • func NewProducts(l *log.Logger, v *data.Validation) *Products
  • func (p *Products) Create(rw http.ResponseWriter, r *http.Request)
  • func (p *Products) Delete(rw http.ResponseWriter, r *http.Request)
  • func (p *Products) ListAll(rw http.ResponseWriter, r *http.Request)
  • func (p *Products) ListSingle(rw http.ResponseWriter, r *http.Request)
  • func (p *Products) MiddlewareContentType(next http.Handler) http.Handler
  • func (p *Products) MiddlewareValidateProduct(next http.Handler) http.Handler
  • func (p *Products) Update(rw http.ResponseWriter, r *http.Request)
• type ValidationError

Variables

var ErrInvalidProductPath = fmt.Errorf("Invalid Path, path should be /products/[id]")

ErrInvalidProductPath is an error message when the product path is not valid

Types

type GenericError

type GenericError struct {
	Message string `json:"message"`
}

GenericError is a generic error message returned by a server

type KeyProduct

type KeyProduct struct{}

KeyProduct is a key used for the Product object in the context

type Products

type Products struct {
	// contains filtered or unexported fields
}

Products handler for getting and updating products

func NewProducts

func NewProducts(l *log.Logger, v *data.Validation) *Products

NewProducts returns a new products handler with the given logger

func (*Products) Create

func (p *Products) Create(rw http.ResponseWriter, r *http.Request)

Create handles POST requests to add new products

func (*Products) Delete

func (p *Products) Delete(rw http.ResponseWriter, r *http.Request)

Delete handles DELETE requests and removes items from the database

func (*Products) ListAll

func (p *Products) ListAll(rw http.ResponseWriter, r *http.Request)

ListAll handles GET requests and returns all current products

func (*Products) ListSingle

func (p *Products) ListSingle(rw http.ResponseWriter, r *http.Request)

ListSingle handles GET requests

func (*Products) MiddlewareContentType

func (p *Products) MiddlewareContentType(next http.Handler) http.Handler

MiddlewareContentType is a convenience handler for adding the application/json content type to every response

func (*Products) MiddlewareValidateProduct

func (p *Products) MiddlewareValidateProduct(next http.Handler) http.Handler

MiddlewareValidateProduct validates the product in the request and calls next if ok

func (*Products) Update

func (p *Products) Update(rw http.ResponseWriter, r *http.Request)

Update handles PUT requests to update products

type ValidationError

type ValidationError struct {
	Messages []string `json:"messages"`
}

ValidationError is a collection of validation error messages