indexes

README

indexes

import "github.com/brittonhayes/warhammer-aos/pkg/indexes"

Index

• func Handler() func(ctx *fiber.Ctx) error
• type Index
  • func (i Index) List() []string
  • func (i *Index) Reply() *handlers.Response

func Handler

func Handler() func(ctx *fiber.Ctx) error

Handler returns an http response all of the indexes as a JSON

type Index

type Index string

const (
    RootIndex   Index = "/api"
    ArmiesIndex       = "/api/armies"
)

func (Index) List

func (i Index) List() []string

List lists out the the available API routes

func (*Index) Reply

func (i *Index) Reply() *handlers.Response

Reply returns the indexes formatted as an API response

Generated by gomarkdoc

Documentation

Index

• func Handler() func(ctx *fiber.Ctx) error
• type Index
  • func (i Index) List() []string
  • func (i *Index) Reply() *handlers.Response

Functions

func Handler

func Handler() func(ctx *fiber.Ctx) error

Handler returns an http response all of the indexes as a JSON

Types

type Index

type Index string

const (
	RootIndex        Index = "/api"
	ArmiesIndex      Index = "/api/armies"
	ArmiesParamIndex Index = "/api/armies/{name}"
)

func (Index) List

func (i Index) List() []string

List lists out the the available API routes

func (*Index) Reply

func (i *Index) Reply() *handlers.Response

Reply returns the indexes formatted as an API response