postman

Documentation

Index

• func EnvironmentFromFile(file string) (map[string]string, error)
• type Collection
  • func CollectionFromFile(file string, options CollectionOptions) (*Collection, error)
  • func (col *Collection) ExtractStructuresDefinition()
• type CollectionOptions
• type Folder
• type Header
• type HeadersList
  • func (list HeadersList) Contains(value string) bool
• type Request
  • func (req Request) Headers() (headers []Header)
  • func (req Request) ParsedURL() *url.URL
• type RequestData
• type Response
• type ResponseHeader
• type StructureDefinition
• type StructureFieldDefinition

Functions

func EnvironmentFromFile

func EnvironmentFromFile(file string) (map[string]string, error)

Types

type Collection

type Collection struct {
	Id          string      `json:"id"`
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Order       []string    `json:"order"`
	Folders     []Folder    `json:"folders"`
	Timestamp   int64       `json:"timestamp"`
	Owner       interface{} `json:"owner"`
	RemoteLink  string      `json:"remoteLink"`
	Public      bool        `json:"public"`
	Requests    []Request   `json:"requests"`
	Structures  []StructureDefinition
}

func CollectionFromFile

func CollectionFromFile(file string, options CollectionOptions) (*Collection, error)

CollectionFromFile parses the content of a file and in a new collection

func (*Collection) ExtractStructuresDefinition

func (col *Collection) ExtractStructuresDefinition()

type CollectionOptions

type CollectionOptions struct {
	IgnoredRequestHeaders  HeadersList
	IgnoredResponseHeaders HeadersList
	EnvironmentVariables   map[string]string
}

type Folder

type Folder struct {
	Id          string      `json:"id"`
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Order       []string    `json:"order"`
	Owner       interface{} `json:"owner"`
}

type Header

type Header struct {
	Name  string
	Value string
}

type HeadersList

type HeadersList []string

func (HeadersList) Contains

func (list HeadersList) Contains(value string) bool

type Request

type Request struct {
	ID               string        `json:"id"`
	RawHeaders       string        `json:"headers"`
	URL              string        `json:"url"`
	PreRequestScript string        `json:"preRequestScript"`
	PathVariables    interface{}   `json:"pathVariables"`
	Method           string        `json:"method"`
	Data             []RequestData `json:"data"`
	DataMode         string        `json:"dataMode"`
	Version          int64         `json:"version"`
	Tests            string        `json:"tests"`
	CurrentHelper    string        `json:"currentHelper"`
	HelperAttributes interface{}   `json:"helperAttributes"`
	Time             interface{}   `json:"time"`
	Name             string        `json:"name"`
	Description      string        `json:"description"`
	CollectionID     string        `json:"collectionId"`
	Responses        []Response    `json:"responses"`
	RawModeData      string        `json:"rawModeData"`
}

func (Request) Headers

func (req Request) Headers() (headers []Header)

func (Request) ParsedURL

func (req Request) ParsedURL() *url.URL

type RequestData

type RequestData struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Response

type Response struct {
	Status       string `json:"status"`
	ResponseCode struct {
		Code   int    `json:"code"`
		Name   string `json:"name"`
		Detail string `json:"detail"`
	} `json:"responseCode"`
	Time        interface{}      `json:"time"`
	Headers     []ResponseHeader `json:"headers"`
	Cookies     []interface{}    `json:"cookies"`
	Mime        string           `json:"mime"`
	Text        string           `json:"text"`
	Language    string           `json:"language"`
	RawDataType string           `json:"rawDataType"`
	State       struct {
		Size string `json:"size"`
	} `json:"state"`
	PreviewType            string      `json:"previewType"`
	SearchResultScrolledTo interface{} `json:"searchResultScrolledTo"`
	ForceNoPretty          bool        `json:"forceNoPretty"`
	Write                  bool        `json:"write"`
	Empty                  bool        `json:"empty"`
	Failed                 bool        `json:"failed"`
	IsSample               bool        `json:"isSample"`
	ScrollToResult         bool        `json:"scrollToResult"`
	RunTests               bool        `json:"runTests"`
	ID                     string      `json:"id"`
	Name                   string      `json:"name"`
	Request                interface{} `json:"request"`
}

type ResponseHeader

type ResponseHeader struct {
	Name        string `json:"name"`
	Key         string `json:"key"`
	Value       string `json:"value"`
	Description string `json:"description"`
}

type StructureDefinition

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

type StructureFieldDefinition

type StructureFieldDefinition struct {
	Name        string
	Description string
	Type        string
}