rest

Documentation

Overview

Package rest implements the pageshot's REST API.

Index

• type Handler
  • func NewHandler(params HandlerParams) *Handler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandlerParams
• type ScreenshotService
• type Server
  • func NewServer(params ServerParams) *Server
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start() error
• type ServerParams

Types

type Handler

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

Handler is an REST HTTP handler.

func NewHandler

func NewHandler(params HandlerParams) *Handler

NewHandler returns net http.Handler.

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP satisfies the http.Handler interface.

type HandlerParams

type HandlerParams struct {
	Logger            *logrus.Logger
	ScreenshotService ScreenshotService
}

HandlerParams is an incoming params for the NewHandler function.

type ScreenshotService

type ScreenshotService interface {
	Screenshot(ctx context.Context, opts models.ScreenshotOptions) (io.Reader, string, error)
}

ScreenshotService is a screenshot interface that is required for the Handler.

type Server

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

Server is main HTTP server.

func NewServer

func NewServer(params ServerParams) *Server

NewServer creates new instance of the Server.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown gracefully shut downs the server.

func (*Server) Start

func (s *Server) Start() error

Start starts the server.

type ServerParams

type ServerParams struct {
	Config  config.ServerConfig
	Handler http.Handler
}

ServerParams is an incoming params for the NewServer function.