postman

Documentation

Index

• Variables
• type BuilderOptions
• type Collection
• type CollectionBuilder
  • func (c *CollectionBuilder) FromFile(file string, options BuilderOptions) (col Collection, err error)
• type CollectionV210Parser
  • func (p *CollectionV210Parser) CanParse(contents []byte) bool
  • func (p *CollectionV210Parser) Parse(contents []byte, options BuilderOptions) (Collection, error)
• type Environment
• type EnvironmentBuilder
  • func (b *EnvironmentBuilder) FromFile(file string) (Environment, error)
• type Folder
• type KeyValuePair
• type Request
• type Response
• type StructureDefinition
• type StructureFieldDefinition

Variables

var (
	ErrRequestNotFound  = errors.New("request not found")
	ErrAllParsersFailed = errors.New("failed to parse collection file, all parsers failed")
)

Types

type BuilderOptions

type BuilderOptions struct {
	IgnoredRequestHeaders  []string
	IgnoredResponseHeaders []string
	EnvironmentVariables   Environment
}

type Collection

type Collection struct {
	Name        string
	Description string
	Requests    []Request
	Folders     []Folder
	Structures  []StructureDefinition
}

type CollectionBuilder

type CollectionBuilder struct {
	Parsers []interface {
		CanParse(contents []byte) bool
		Parse(contents []byte, options BuilderOptions) (Collection, error)
	}
}

func (*CollectionBuilder) FromFile

func (c *CollectionBuilder) FromFile(file string, options BuilderOptions) (col Collection, err error)

type CollectionV210Parser

type CollectionV210Parser struct{}

func (*CollectionV210Parser) CanParse

func (p *CollectionV210Parser) CanParse(contents []byte) bool

func (*CollectionV210Parser) Parse

func (p *CollectionV210Parser) Parse(contents []byte, options BuilderOptions) (Collection, error)

type Environment

type Environment map[string]string

type EnvironmentBuilder

type EnvironmentBuilder struct{}

func (*EnvironmentBuilder) FromFile

func (b *EnvironmentBuilder) FromFile(file string) (Environment, error)

type Folder

type Folder struct {
	ID          string
	Name        string
	Description string
	Folders     []Folder
	Requests    []Request
}

type KeyValuePair

type KeyValuePair struct {
	Name        string
	Key         string
	Value       interface{}
	Description string
}

type Request

type Request struct {
	ID            string
	Name          string
	Description   string
	Method        string
	URL           string
	PayloadType   string
	PayloadRaw    string
	PayloadParams []KeyValuePair
	PathVariables []KeyValuePair
	Headers       []KeyValuePair
	Responses     []Response
	Tests         string
}

type Response

type Response struct {
	ID         string
	Name       string
	Status     string
	StatusCode int
	Body       string
	Headers    []KeyValuePair
}

type StructureDefinition

type StructureDefinition struct {
	Name        string
	Description string
	Fields      []StructureFieldDefinition
}

type StructureFieldDefinition

type StructureFieldDefinition struct {
	Name        string
	Description string
	Type        string
}