web

Documentation

Index

• func LoggerMiddleware(logger tools.Logger) func(http.Handler) http.Handler
• func OptionalMiddlewares(active bool, middlewares ...func(http.Handler) http.Handler) func(http.Handler) http.Handler
• type Client
  • func NewClient(logger tools.Logger, baseURL string, prepare ...PrepareClientFn) (client *Client, err error)
  • func (c *Client) Do(req *http.Request, prepare ...PrepareRequestFn) (*http.Response, error)
  • func (c *Client) Json(method string, path string, query url.Values, reqBody, respBody any) error
• type PrepareClientFn
• type PrepareRequestFn
• type Response
  • func NewResponse[T any](data T) *Response[T]
  • func (r *Response[T]) Write(code int, wr http.ResponseWriter)
• type Server
  • func NewServer(logger tools.Logger) *Server
  • func (s *Server) Run(ctx context.Context, port int, h http.Handler)
  • func (s *Server) Shutdown(ctx context.Context) error

Functions

func LoggerMiddleware

func LoggerMiddleware(logger tools.Logger) func(http.Handler) http.Handler

LoggerMiddleware is a middleware that logs requests and responses middleware uses [DEBUG] level

func OptionalMiddlewares

func OptionalMiddlewares(active bool, middlewares ...func(http.Handler) http.Handler) func(http.Handler) http.Handler

OptionalMiddlewares returns a middleware that applies the given middlewares

Types

type Client

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

func NewClient

func NewClient(logger tools.Logger, baseURL string, prepare ...PrepareClientFn) (client *Client, err error)

NewClient creates a new client instance

func (*Client) Do

func (c *Client) Do(req *http.Request, prepare ...PrepareRequestFn) (*http.Response, error)

Do sends the request and returns the response

func (*Client) Json

func (c *Client) Json(method string, path string, query url.Values, reqBody, respBody any) error

PrepareClient returns a new client with the given prepare functions

type PrepareClientFn

type PrepareClientFn func(*http.Client) *http.Client

type PrepareRequestFn

type PrepareRequestFn func(*http.Request) *http.Request

type Response

type Response[T any] struct {
	Success bool   `json:"success"`
	Message string `json:"message,omitempty"`
	Data    T      `json:"data,omitempty"`
}

Response is a generic response structure

func NewResponse

func NewResponse[T any](data T) *Response[T]

NewResponse creates a new response

func (*Response[T]) Write

func (r *Response[T]) Write(code int, wr http.ResponseWriter)

Write writes the response to the writer

type Server

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

func NewServer

func NewServer(logger tools.Logger) *Server

NewServer creates a new server instance

func (*Server) Run

func (s *Server) Run(ctx context.Context, port int, h http.Handler)

Run starts the server

func (*Server) Shutdown

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