api

package

v0.0.2-alpha4 Latest Latest Go to latest Published: Apr 8, 2023 License: BSD-3-Clause Imports: 10 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/atticus-sullivan/freezerDB

Documentation ¶

Index ¶

Variables
func AuthenticatorSimpleSingleKey(key string) func(next http.Handler) http.Handler
func ErrInternal(err error) render.Renderer
func ErrInvalidRequest(err error) render.Renderer
func ErrRender(err error) render.Renderer
func NewListResponse[T render.Renderer](items []T) []render.Renderer
type CategoryRequest
- func (c *CategoryRequest) Bind(r *http.Request) error
type CategoryResponse
- func (c CategoryResponse) Render(w http.ResponseWriter, r *http.Request) error
type ErrResponse
- func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error
type FreezerItemRequest
- func (c *FreezerItemRequest) Bind(r *http.Request) error
type FreezerItemResponse
- func (c FreezerItemResponse) Render(w http.ResponseWriter, r *http.Request) error
type ItemTypeRequest
- func (c *ItemTypeRequest) Bind(r *http.Request) error
type ItemTypeResponse
- func (c ItemTypeResponse) Render(w http.ResponseWriter, r *http.Request) error
type Server
- func CreateNewServer(db *sqlx.DB) *Server
- func (s *Server) Doc()
- func (s *Server) MountHandlers(key string)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrForbidden = ErrNotFound

Servers may also send 404 Not found instead of 403 Forbidden to hide the existence of a resource from an unauthorized client.

View Source

var ErrInvalidID error = errors.New("Invalid Item ID")

View Source

var ErrItemNotFount error = errors.New("Item not found")

View Source

var ErrNotFound = &ErrResponse{
	HTTPStatusCode: http.StatusNotFound,
	StatusText:     "Resource not found.",
}

Functions ¶

func AuthenticatorSimpleSingleKey ¶

func AuthenticatorSimpleSingleKey(key string) func(next http.Handler) http.Handler

func ErrInternal ¶

func ErrInternal(err error) render.Renderer

func ErrInvalidRequest ¶

func ErrInvalidRequest(err error) render.Renderer

func ErrRender ¶

func ErrRender(err error) render.Renderer

func NewListResponse ¶

func NewListResponse[T render.Renderer](items []T) []render.Renderer

Types ¶

type CategoryRequest ¶

type CategoryRequest struct{ models.Category }

func (*CategoryRequest) Bind ¶

func (c *CategoryRequest) Bind(r *http.Request) error

type CategoryResponse ¶

type CategoryResponse struct{ models.Category }

func (CategoryResponse) Render ¶

func (c CategoryResponse) Render(w http.ResponseWriter, r *http.Request) error

type ErrResponse ¶

type ErrResponse struct {
	Err            error `json:"-"` // low-level runtime error
	HTTPStatusCode int   `json:"-"` // http response status code

	StatusText string `json:"status"`          // user-level status message
	AppCode    int64  `json:"code,omitempty"`  // application-specific error code
	ErrorText  string `json:"error,omitempty"` // application-level error message, for debugging
}

ErrResponse renderer type for handling all sorts of errors.

In the best case scenario, the excellent github.com/pkg/errors package helps reveal information on the error, setting it on Err, and in the Render() method, using it to set the application-specific error code in AppCode.

func (*ErrResponse) Render ¶

func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

type FreezerItemRequest ¶

type FreezerItemRequest struct{ models.FreezerItem }

func (*FreezerItemRequest) Bind ¶

func (c *FreezerItemRequest) Bind(r *http.Request) error

type FreezerItemResponse ¶

type FreezerItemResponse struct{ models.FreezerItem }

func (FreezerItemResponse) Render ¶

func (c FreezerItemResponse) Render(w http.ResponseWriter, r *http.Request) error

type ItemTypeRequest ¶

type ItemTypeRequest struct{ models.ItemType }

func (*ItemTypeRequest) Bind ¶

func (c *ItemTypeRequest) Bind(r *http.Request) error

type ItemTypeResponse ¶

type ItemTypeResponse struct{ models.ItemType }

func (ItemTypeResponse) Render ¶

func (c ItemTypeResponse) Render(w http.ResponseWriter, r *http.Request) error

type Server ¶

type Server struct {
	Router *chi.Mux
	DB     *sqlx.DB
}

func CreateNewServer ¶

func CreateNewServer(db *sqlx.DB) *Server

func (*Server) Doc ¶

func (s *Server) Doc()

func (*Server) MountHandlers ¶

func (s *Server) MountHandlers(key string)

Source Files ¶

View all Source files

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