server

package

v0.0.0-...-72b452d Latest Latest Go to latest Published: Aug 8, 2022 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/jlucktay/rest-api

Links

Open Source Insights

Documentation ¶

Index ¶

type PaymentData
type ReadWrapper
- func NewWrapper(s string) *ReadWrapper
- func (rw *ReadWrapper) AddPayment(id uuid.UUID, p storage.Payment)
type ReadWrapperLinks
type Server
- func New(st StorageType, logDebug bool, cs ...string) *Server
type StorageType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PaymentData ¶

type PaymentData struct {
	Attributes     storage.Payment `json:"attributes"`
	ID             uuid.UUID       `json:"id"`
	OrganisationID uuid.UUID       `json:"organisation_id"`
	Type           string          `json:"type"`
	Version        int             `json:"version"`
}

type ReadWrapper ¶

type ReadWrapper struct {
	Data  []PaymentData    `json:"data"`
	Links ReadWrapperLinks `json:"links"`
}

ReadWrapper adds some extra information around Payment structs that are read from the API.

func NewWrapper ¶

func NewWrapper(s string) *ReadWrapper

NewWrapper will return a new ReadWrapper.

func (*ReadWrapper) AddPayment ¶

func (rw *ReadWrapper) AddPayment(id uuid.UUID, p storage.Payment)

AddPayment will add a Payment with some other boilerplate attributes to a ReadWrapper.

type ReadWrapperLinks ¶

type ReadWrapperLinks struct {
	Self string `json:"self"`
}

type Server ¶

type Server struct {
	Router  *chi.Mux
	Storage storage.PaymentStorage
}

Server is a RESTful HTTP API server offering CRUD functionality to store Payments.

func New ¶

func New(st StorageType, logDebug bool, cs ...string) *Server

New creates a new Server utilising the given StorageType to handle Payment storage, and sets up the HTTP router. It takes an optional string argument which will set the hostname of the MongoDB server to connect to.

type StorageType ¶

type StorageType byte

StorageType is an enum to differentiate between storage implementations.

const (
	// InMemory describes a storage system that is held in memory only, and not persisted to disk.
	InMemory StorageType = iota

	// Mongo describes a storage system that persists Payment records in a MongoDB database.
	Mongo
)

Source Files ¶

View all Source files

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