rest

package

v0.1.0 Latest Latest Go to latest Published: Apr 2, 2022 License: MIT 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

Package rest implements the pageshot's REST API.

This section is empty.

This section is empty.

This section is empty.

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

Handler is an REST HTTP handler.

func NewHandler(params HandlerParams) *Handler

NewHandler returns net http.Handler.

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

ServeHTTP satisfies the http.Handler interface.

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

HandlerParams is an incoming params for the NewHandler function.

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 struct {
	// contains filtered or unexported fields
}

Server is main HTTP server.

func NewServer(params ServerParams) *Server

NewServer creates new instance of the Server.

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

Shutdown gracefully shut downs the server.

func (s *Server) Start() error

Start starts the server.

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

ServerParams is an incoming params for the NewServer function.