httpapi

Documentation

Index

• func NewServer(config *Configuration, dep *ServerDependencies) http.Server
• func RedocSpec() http.Handler
• func Spec(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
• type Configuration
  • func (c *Configuration) Validate() error
• type ServerDependencies

Functions

func NewServer

func NewServer(config *Configuration, dep *ServerDependencies) http.Server

NewServer creates an http server

func RedocSpec

func RedocSpec() http.Handler

RedocSpec returns handler for API Redoc documentation

func Spec

func Spec(w http.ResponseWriter, r *http.Request, _ httprouter.Params)

Spec returns the swagger 2.0 spec

Types

type Configuration

type Configuration struct {
	Address      string
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
}

Configuration for running the server

func (*Configuration) Validate

func (c *Configuration) Validate() error

Validate the server configuration

type ServerDependencies

type ServerDependencies struct {
	Logger         log.Logger
	ImgService     imgart.ImageService
	ProfileService imgart.ProfileService
	Health         health.Health
}

ServerDependencies contains all dependencies