controller

Documentation

Overview

Copyright (C) 2019 - 2022 MWSOFT This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Index

• type Controller
  • func New(s service.Service, logger *zap.Logger, timeFormat string) *Controller
  • func (ctl *Controller) Health(c *gin.Context)
  • func (ctl *Controller) RegisterRoutes() *gin.Engine
  • func (ctl *Controller) Suggest(c *gin.Context)

Types

type Controller

type Controller struct {
	Service    service.Service
	Logger     *zap.Logger
	TimeFormat string
}

Controller holds the Controller data.

func New

func New(s service.Service, logger *zap.Logger, timeFormat string) *Controller

New returns new controller.

func (*Controller) Health

func (ctl *Controller) Health(c *gin.Context)

Health is used for health checks from loadbalancer.

func (*Controller) RegisterRoutes

func (ctl *Controller) RegisterRoutes() *gin.Engine

RegisterRoutes registers all the superhero_suggestions API routes.

func (*Controller) Suggest

func (ctl *Controller) Suggest(c *gin.Context)

Suggest returns the suggestions for the Superhero.