model

Documentation

Index

• type API
  • func APIFromYAML(body []byte) (*API, error)
  • func BuildAPIWithEndpoints(apiName string, endpoints []*Endpoint) *API
  • func (a *API) ToYAML() (string, error)
• type Endpoint

Types

type API

type API struct {
	Name      string               `yaml:"name"`
	Endpoints map[string]*Endpoint `yaml:"endpoints"`
}

API represents a entire model of API

func APIFromYAML

func APIFromYAML(body []byte) (*API, error)

APIFromYAML creates API object from YAML

func BuildAPIWithEndpoints

func BuildAPIWithEndpoints(apiName string, endpoints []*Endpoint) *API

BuildAPIWithEndpoints craete new build object with the given endpoints

func (*API) ToYAML

func (a *API) ToYAML() (string, error)

ToYAML converts API object to YAML

type Endpoint

type Endpoint struct {
	Path      string `yaml:"-"`
	TargetURL string `yaml:"url"`
}

Endpoint represents API endpoint