rest

Documentation

Overview

Package rest contains all methods and middleware for working web server.

Index

• func InitMetrics(namespace string, flatSwaggerJSON json.RawMessage)
• func New(application app.App, logger *zap.Logger, options ...Option) (*restapi.Server, error)
• func User(u *app.User) *models.User
• func Users(u []app.User) []*models.User
• type Option
  • func SetBasePath(basePath string) Option
  • func SetHost(host string) Option
  • func SetPort(port int) Option

Functions

func InitMetrics

func InitMetrics(namespace string, flatSwaggerJSON json.RawMessage)

InitMetrics must be called once before using this package. It registers and initializes metrics used by this package.

func New

func New(application app.App, logger *zap.Logger, options ...Option) (*restapi.Server, error)

New returns Swagger server configured to listen on the TCP network.

func User

func User(u *app.User) *models.User

User conversion userApp.User => models.User.

func Users

func Users(u []app.User) []*models.User

Users conversion []userApp.User => []*models.User.

Types

type Option

type Option func(*config)

Option for run server.

func SetBasePath

func SetBasePath(basePath string) Option

SetBasePath sets the base path to handlers. Default: /api/v1.

func SetHost

func SetHost(host string) Option

SetHost sets server host. Default: localhost.

func SetPort

func SetPort(port int) Option

SetPort sets server port. Default: 8080.