parser

Documentation

Index

• func DefinitionNameFromRef(ref oas.Ref) (string, string)
• func Enum2string(enums ...interface{}) string
• func Parse(sourcePath string) (*oas.Swagger, error)
• func SortMap(hashmap interface{}) []string
• type APIHeader
• type APIRequest
• type APIResponse
• type SwageAPI
• type SwageSpec
  • func Convert(swagger *oas.Swagger) (*SwageSpec, error)

Functions

func DefinitionNameFromRef

func DefinitionNameFromRef(ref oas.Ref) (string, string)

func Enum2string

func Enum2string(enums ...interface{}) string

func Parse

func Parse(sourcePath string) (*oas.Swagger, error)

Parse `JSON`, `YAML` to Go struct

func SortMap

func SortMap(hashmap interface{}) []string

Types

type APIHeader

type APIHeader struct {
	Tag         string
	ID          string
	Path        string
	Method      string
	Consumes    string
	Produces    string
	Summary     string
	Description string
}

type APIRequest

type APIRequest struct {
	Required      string
	Schema        string
	ParameterType string // path, body, query, header, ...
	DataType      string // string, integer, boolean, object, ...
	Enum          string
	Example       string
	Description   string
}

type APIResponse

type APIResponse struct {
	StatusCode   string
	Schema       string
	ResponseType string // body
	DataType     string // string, integer, boolean, object, ...
	Enum         string
	Example      string
	Description  string
}

type SwageAPI

type SwageAPI struct {
	Header   APIHeader
	Request  []APIRequest
	Response []APIResponse
}

type SwageSpec

type SwageSpec struct {
	API []SwageAPI
}

func Convert

func Convert(swagger *oas.Swagger) (*SwageSpec, error)

Convert Open API Spec to Swage Spec