data

package
v0.0.0-...-d421191 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 26, 2022 License: GPL-3.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrProductNotFound = fmt.Errorf("Product not found")

Functions

func AddProduct

func AddProduct(p Product)

AddProduct adds a new product to the database

func DeleteProduct

func DeleteProduct(id int) error

DeleteProduct deletes a product from the database

func FromJSON

func FromJSON(i interface{}, r io.Reader) error

FromJSON deserializes the object from JSON string in an io.Reader to the given interface

func ToJSON

func ToJSON(i interface{}, w io.Writer) error

ToJSON serializes the given interface into a string based JSON format

func UpdateProduct

func UpdateProduct(p Product) error

UpdateProduct replaces a product in the database with the given item. If a product with the given id does not exist in the database this function returns a ProductNotFound error

Types

type Product

type Product struct {
	// the id for this Product
	//
	// required: true
	// min: 1
	ID int `json:"id"`

	// the name for this product
	//
	// required: true
	// max length: 255
	Name string `json:"name" validate:"required"`

	// the description for this product
	//
	// required: false
	// max length: 10000
	Description string `json:"description"`

	// the price for the product
	//
	// required: true
	// min: 0.01
	Price float32 `json:"price" validate:"gt=0"`

	// the SKU for the product
	//
	// required: true
	// pattern: [a-z]+-[a-z]+-[a-z]+
	SKU       string `json:"sku" validate:"required,sku"`
	CreatedOn string `json:"-"`
	UpdatedOn string `json:"-"`
	DeletedOn string `json:"-"`
}

Product defines the structure for an API product swagger:model

func GetProductByID

func GetProductByID(id int) (*Product, error)

GetProductByID returns a single product which matches the id from the database. If a product is not found this function returns a ProductNotFound error

func (*Product) FromJSON

func (p *Product) FromJSON(r io.Reader) error

func (*Product) Validate

func (p *Product) Validate() error

type Products

type Products []*Product

Products defines a slice of Product

func GetProducts

func GetProducts() Products

GetProducts returns all products from the database

func (*Products) ToJSON

func (p *Products) ToJSON(w io.Writer) error

type Validation

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

Validation contains

func NewValidation

func NewValidation() *Validation

NewValidation creates a new Validation type

func (*Validation) Validate

func (v *Validation) Validate(i interface{}) ValidationErrors

Validate the item for more detail the returned error can be cast into a validator.ValidationErrors collection

if ve, ok := err.(validator.ValidationErrors); ok {
			fmt.Println(ve.Namespace())
			fmt.Println(ve.Field())
			fmt.Println(ve.StructNamespace())
			fmt.Println(ve.StructField())
			fmt.Println(ve.Tag())
			fmt.Println(ve.ActualTag())
			fmt.Println(ve.Kind())
			fmt.Println(ve.Type())
			fmt.Println(ve.Value())
			fmt.Println(ve.Param())
			fmt.Println()
	}

type ValidationError

type ValidationError struct {
	validator.FieldError
}

ValidationError wraps the validators FieldError so we do not expose this to out code

func (ValidationError) Error

func (v ValidationError) Error() string

type ValidationErrors

type ValidationErrors []ValidationError

ValidationErrors is a collection of ValidationError

func (ValidationErrors) Errors

func (v ValidationErrors) Errors() []string

Errors converts the slice into a string slice

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL