http

Documentation

Index

• Variables
• func NewServer(container *registry.Container) *http.Server
• func SetupRouter(container *registry.Container) *gin.Engine
• type RequireRoleMiddlewareFactory

Variables

var (
	ErrMethodNotAllowed = dto.NewI18nError("method not allowed", "errors.method_not_allowed")
	ErrRouteNotFound    = dto.NewI18nError("route not found", "errors.route_not_found")
)

Functions

func NewServer

func NewServer(container *registry.Container) *http.Server

func SetupRouter

func SetupRouter(container *registry.Container) *gin.Engine

SetupRouter godoc

@title						Mandarine API
@version					0.0.0
@description				API for web and mobile application Mandarine
@host						localhost:8080
@accept						json
@produce					json
@tag.name					Account API
@tag.description			API for account management
@tag.name					Authentication and Authorization API
@tag.description			API for authentication and authorization
@tag.name					Geocoding API
@tag.description			API for geocoding
@tag.name					Master Profile API
@tag.description			API for master profile management
@tag.name					Resource API
@tag.description			API for resource management
@tag.name					Websocket API
@tag.description			API for websocket connection
@tag.name					Metrics API
@tag.description			API for getting metrics
@tag.name					Swagger API
@tag.description			API for getting swagger documentation
@contact.name				Mandarine Support
@contact.email				mandarine.app@yandex.ru
@license.name				Apache 2.0
@license.url				http://www.apache.org/licenses/LICENSE-2.0.html
@securityDefinitions.apikey	BearerAuth
@in							header
@name						Authorization
@externalDocs.description	OpenAPI
@externalDocs.url			https://swagger.io/resources/open-api/

Types

type RequireRoleMiddlewareFactory

type RequireRoleMiddlewareFactory func(...string) gin.HandlerFunc