postman

package

v0.1.0 Latest Latest Go to latest Published: Apr 9, 2024 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/joakim-ribier/go-cli-4Postman

Documentation ¶

Index ¶

type Auth
- func (a Auth) GetAuthBasicCredential(env *Env, params []Param) (string, string)
type AuthBasicValue
type Body
- func (u Body) Get(env *Env, params []Param) string
type Collection
- func (c Collection) FindByMethod(method string) Items
- func (c Collection) FindItemByLabel(label string) *Item
- func (c Collection) GetMethods() []string
- func (c Collection) SortByName() Collection
type CollectionHistoryItem
- func NewCollectionHistoryItem(item *Item, status string, body []byte, env *Env, params []Param) CollectionHistoryItem
- func (i CollectionHistoryItem) GetSuggestDescription() string
type CollectionHistoryItems
- func (r CollectionHistoryItems) FindByLabel(label string) *CollectionHistoryItem
- func (r CollectionHistoryItems) SortByExecutedAt() CollectionHistoryItems
type Env
- func NewEnv() Env
- func (e Env) GetName() string
type EnvParam
type Header
type Headers
- func (h Headers) Get(env *Env, params []Param) map[string]string
type Info
type Item
- func (i Item) Contains(pattern string) ItemContainsPattern
- func (i Item) GetLabel() string
- func (i Item) GetParams() []string
- func (i Item) IsRequest() bool
type ItemContainsPattern
- func (i ItemContainsPattern) Contains() bool
type Items
- func (items Items) SortByLabel() Items
- func (items Items) SortByName() Items
type Metadata
type PSTCollection
type PSTCollections
type PSTEnvironment
type PSTEnvironments
type PSTWorkspace
type PSTWorkspaces
- func (w PSTWorkspaces) Find(workspaceIdOrName string) *PSTWorkspace
type Param
type PostmanCollection
type PostmanEnvironment
type Request
type Url
- func (u Url) Get(env *Env, params []Param) string
- func (u Url) GetLongPath() string
- func (u Url) GetShortPath() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Auth ¶

type Auth struct {
	Type  string
	Basic []AuthBasicValue
}

func (Auth) GetAuthBasicCredential ¶

func (a Auth) GetAuthBasicCredential(env *Env, params []Param) (string, string)

GetAuthBasicCredential returns the couple {username}/{password} for basic authentication type.

type AuthBasicValue ¶

type AuthBasicValue struct {
	Key   string
	Value string
}

type Body ¶

type Body struct {
	Raw string
}

func (Body) Get ¶

func (u Body) Get(env *Env, params []Param) string

Get builds the API {body} using the provided context (env and params).

type Collection ¶

type Collection struct {
	Info     Info
	Items    Items    `json:"item"`
	Metadata Metadata // compute date
}

func (Collection) FindByMethod ¶

func (c Collection) FindByMethod(method string) Items

FindByMethod finds the items that match with the {method}.

func (Collection) FindItemByLabel ¶

func (c Collection) FindItemByLabel(label string) *Item

FindItemByLabel finds the item that matches with the {label}.

func (Collection) GetMethods ¶

func (c Collection) GetMethods() []string

GetMethods finds the items methods.

func (Collection) SortByName ¶

func (c Collection) SortByName() Collection

SortByName sorts collection items by the {name} field.

type CollectionHistoryItem ¶

type CollectionHistoryItem struct {
	Item *Item

	Status string
	Body   []byte

	Env    *Env
	Params []Param

	ExecutedAt time.Time
}

func NewCollectionHistoryItem ¶

func NewCollectionHistoryItem(item *Item, status string, body []byte, env *Env, params []Param) CollectionHistoryItem

func (CollectionHistoryItem) GetSuggestDescription ¶

func (i CollectionHistoryItem) GetSuggestDescription() string

GetSuggestDescription builds a descriptionof the collection history items for the prompt.

type CollectionHistoryItems ¶

type CollectionHistoryItems []CollectionHistoryItem

func (CollectionHistoryItems) FindByLabel ¶

func (r CollectionHistoryItems) FindByLabel(label string) *CollectionHistoryItem

FindByLabel finds collection history item that matches with {label}.

func (CollectionHistoryItems) SortByExecutedAt ¶

func (r CollectionHistoryItems) SortByExecutedAt() CollectionHistoryItems

SortByExecutedAt sorts collection history items by {executedAt} field.

type Env ¶

type Env struct {
	Name   string
	Params []EnvParam `json:"values"`
}

func NewEnv ¶

func NewEnv() Env

func (Env) GetName ¶

func (e Env) GetName() string

type EnvParam ¶

type EnvParam struct {
	Key   string
	Value string
}

type Header ¶

type Header struct {
	Key   string
	Value string
}

type Headers ¶

type Headers []Header

func (Headers) Get ¶

func (h Headers) Get(env *Env, params []Param) map[string]string

Get builds the header params using the provided context (env and params).

type Info ¶

type Info struct {
	Name string
}

type Item ¶

type Item struct {
	Name    string
	Request Request `json:"request,omitempty"`
	Items   Items   `json:"item,omitempty"`
}

func (Item) Contains ¶

func (i Item) Contains(pattern string) ItemContainsPattern

func (Item) GetLabel ¶

func (i Item) GetLabel() string

GetLabel builds the item label "{METHOD}.../{path[len(path)-3:]}" computed field.

func (Item) GetParams ¶

func (i Item) GetParams() []string

GetParams finds all params from {url} annd {body} fields.

func (Item) IsRequest ¶

func (i Item) IsRequest() bool

IsRequest returns {true} if the item is an API request.

type ItemContainsPattern ¶

type ItemContainsPattern struct {
	Parent bool
	Child  bool
}

func (ItemContainsPattern) Contains ¶

func (i ItemContainsPattern) Contains() bool

type Items ¶

type Items []Item

func (Items) SortByLabel ¶

func (items Items) SortByLabel() Items

SortByLabel sorts items by the {label} computed field.

func (Items) SortByName ¶

func (items Items) SortByName() Items

SortByName sorts items by the {name} field.

type Metadata ¶

type Metadata struct {
	Methods []string
}

type PSTCollection ¶

type PSTCollection struct {
	Id   string
	Name string
}

type PSTCollections ¶

type PSTCollections struct {
	Collections []PSTCollection
}

type PSTEnvironment ¶

type PSTEnvironment struct {
	Id   string
	Name string
}

type PSTEnvironments ¶

type PSTEnvironments struct {
	Environments []PSTEnvironment
}

type PSTWorkspace ¶

type PSTWorkspace struct {
	Id   string
	Name string
}

type PSTWorkspaces ¶

type PSTWorkspaces struct {
	Workspaces []PSTWorkspace
}

func (PSTWorkspaces) Find ¶

func (w PSTWorkspaces) Find(workspaceIdOrName string) *PSTWorkspace

type Param ¶

type Param struct {
	Key   string
	Value string
}

type PostmanCollection ¶

type PostmanCollection struct {
	Collection Collection
}

type PostmanEnvironment ¶

type PostmanEnvironment struct {
	Environment Env
}

type Request ¶

type Request struct {
	Method string
	Header Headers `json:"header,omitempty"`
	Url    Url
	Auth   Auth
	Body   Body
}

type Url ¶

type Url struct {
	Raw  string
	Path []string
}

func (Url) Get ¶

func (u Url) Get(env *Env, params []Param) string

Get builds the API {url} using the provided context (env and params).

func (Url) GetLongPath ¶

func (u Url) GetLongPath() string

GetLongPath builds the API path.

func (Url) GetShortPath ¶

func (u Url) GetShortPath() string

GetShortPath builds the short (3 max) API path.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL