api

Documentation

Overview

Package api provides a structure for designing an API for your app.

Index

• func Routes(root seed.Seed) map[string]http.Handler
• type Design
  • func New(options ...Option) Design
  • func (d Design) AddTo(c seed.Seed)
  • func (d Design) And(more ...seed.Option) seed.Option
• type Option
  • func Endpoint(route string, handler interface{}) Option

Functions

func Routes

func Routes(root seed.Seed) map[string]http.Handler

Types

type Design

type Design struct {
	// contains filtered or unexported fields
}

Design is an API design for your app.

func New

func New(options ...Option) Design

New returns a new API design.

func (Design) AddTo

func (d Design) AddTo(c seed.Seed)

AddTo app.

func (Design) And

func (d Design) And(more ...seed.Option) seed.Option

type Option

type Option func(*Design)

func Endpoint

func Endpoint(route string, handler interface{}) Option

Endpoint is an API endpoint with a route and handler.