api

Documentation

Index

• func LoggerMiddleware(r *mux.Router) mux.MiddlewareFunc
• func NewStatusResponseWriter(w http.ResponseWriter) *statusResponseWriter
• func RequestIDLoggerMiddleware(r *mux.Router) mux.MiddlewareFunc
• func URLSchemaMiddleware(r *mux.Router) mux.MiddlewareFunc
• type API
  • func New(port int, db storage.Storage) *API
  • func (api *API) Run(ctx context.Context) error
• type PaginatedResponse
• type Paginator

Functions

func LoggerMiddleware

func LoggerMiddleware(r *mux.Router) mux.MiddlewareFunc

Log each HTTP request with its execution time and request_id

func NewStatusResponseWriter

func NewStatusResponseWriter(w http.ResponseWriter) *statusResponseWriter

func RequestIDLoggerMiddleware

func RequestIDLoggerMiddleware(r *mux.Router) mux.MiddlewareFunc

Generate (if there is none) and store request_id both in the request context AND X-REQUEST-ID header

func URLSchemaMiddleware

func URLSchemaMiddleware(r *mux.Router) mux.MiddlewareFunc

Types

type API

type API struct {
	HttpListenPort int
	// contains filtered or unexported fields
}

func New

func New(port int, db storage.Storage) *API

func (*API) Run

func (api *API) Run(ctx context.Context) error

type PaginatedResponse

type PaginatedResponse struct {
	Articles  []storage.ArticleShort `json:"articles"`
	Paginator Paginator              `json:"paginator"`
}

type Paginator

type Paginator struct {
	NumPages int `json:"num_pages"`
	CurPage  int `json:"cur_page"`
	PageSize int `json:"page_size"`
}