topostman2

package

v1.1.3 Latest Latest Go to latest Published: Jan 10, 2021 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/grokify/swaggman

Links

Open Source Insights

Documentation ¶

Index ¶

func BuildPostmanURL(cfg Configuration, spec *oas3.Swagger, specPath string, ...) postman2.URL
func Convert(cfg Configuration, oas3spec *oas3.Swagger) (postman2.Collection, error)
func CreateTagsAndTagGroups(pman postman2.Collection, spec *oas3.Swagger) (postman2.Collection, error)
func Merge(cfg Configuration, pman postman2.Collection, oas3spec *oas3.Swagger) (postman2.Collection, error)
func Openapi3OperationToPostman2APIItem(cfg Configuration, oas3spec *oas3.Swagger, url string, method string, ...) *postman2.Item
func ParamsOpenAPI3ToPostman(oparams []*oas3.ParameterRef) postman2.URLParameters
func PostmanUrlAddDefaultsOAS3(pmanURL postman2.URL, operation *oas3.Operation) postman2.URL
type Configuration
type Converter
- func NewConverter(cfg Configuration) Converter
- func (conv *Converter) Convert(openapiFilepath string, pmanSpecFilepath string) error
- func (conv *Converter) MergeConvert(openapiFilepath string, pmanBaseFilepath string, pmanSpecFilepath string) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BuildPostmanURL ¶

func BuildPostmanURL(cfg Configuration, spec *oas3.Swagger, specPath string, operation *oas3.Operation) postman2.URL

func Convert ¶

func Convert(cfg Configuration, oas3spec *oas3.Swagger) (postman2.Collection, error)

Convert creates a Postman 2.0 collection from a configuration and Swagger 2.0 spec

func CreateTagsAndTagGroups ¶

func CreateTagsAndTagGroups(pman postman2.Collection, spec *oas3.Swagger) (postman2.Collection, error)

func Merge ¶

func Merge(cfg Configuration, pman postman2.Collection, oas3spec *oas3.Swagger) (postman2.Collection, error)

Merge creates a Postman 2.0 collection from a configuration, base Postman 2.0 collection and Swagger 2.0 spec

func Openapi3OperationToPostman2APIItem ¶

func Openapi3OperationToPostman2APIItem(cfg Configuration, oas3spec *oas3.Swagger, url string, method string, operation *oas3.Operation) *postman2.Item

func ParamsOpenAPI3ToPostman ¶

func ParamsOpenAPI3ToPostman(oparams []*oas3.ParameterRef) postman2.URLParameters

ParamsOpenAPI3ToPostman returns a slices of Postman parameters for a slice of OpenAPI 3 parameters.

func PostmanUrlAddDefaultsOAS3 ¶

func PostmanUrlAddDefaultsOAS3(pmanURL postman2.URL, operation *oas3.Operation) postman2.URL

Types ¶

type Configuration ¶

type Configuration struct {
	PostmanServerURLBasePath string            `json:"postmanServerUrlApiBasePath,omitempty"`
	PostmanServerURL         string            `json:"postmanServerUrl,omitempty"`
	PostmanURLHostname       string            `json:"postmanURLHostname,omitempty"`
	PostmanHeaders           []postman2.Header `json:"postmanHeaders,omitempty"`
	UseXTagGroups            bool              `json:"useXTagGroups,omitempty"`
}

Configuration is a Swaggman configuration that holds information on how to create the Postman 2.0 collection including overriding Swagger 2.0 spec values.

type Converter ¶

type Converter struct {
	Configuration Configuration
	Swagger       *oas3.Swagger
}

Converter is the struct that manages the conversion.

func NewConverter ¶

func NewConverter(cfg Configuration) Converter

NewConverter instantiates a new converter.

func (*Converter) Convert ¶

func (conv *Converter) Convert(openapiFilepath string, pmanSpecFilepath string) error

Convert builds a Postman 2.0 spec using a Swagger 2.0 spec.

func (*Converter) MergeConvert ¶

func (conv *Converter) MergeConvert(openapiFilepath string, pmanBaseFilepath string, pmanSpecFilepath string) error

MergeConvert builds a Postman 2.0 spec using a base Postman 2.0 collection and a Swagger 2.0 spec.

Source Files ¶

View all Source files

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