parser

Documentation

Overview

Package parser parses API definitions in Go

Package parser parses API definitions in Go

Package parser parses API definitions in Go

Index

• Constants
• type Endpoint
  • func (e *Endpoint) GetFullPath(splitter string, fn func(rawPath, path, placeholder string) string) string
  • func (e *Endpoint) GetParent() *Group
• type Group
  • func Parse(dir string) (*Group, error)
  • func (g *Group) GetFullPath(splitter string, fn func(rawPath, path, placeholder string) string) string
  • func (g *Group) GetParent() *Group
• type MethodType

Constants

const (
	// QueryParamTag is the tag name for parameters in query
	QueryParamTag = "param"

	// JSONParamTag is the tag name for JSON
	JSONParamTag = "json"
)

Types

type Endpoint

type Endpoint struct {
	Method        MethodType
	RawPath, Path string
	Placeholder   string

	RequestPayloadName   string
	ResponsePayloadName  string
	RequestPayload       *ast.StructType
	ResponsePayload      *ast.StructType
	RequestGo2tsPayload  *go2tstypes.Object
	ResponseGo2tsPayload *go2tstypes.Object

	SwagComments []string

	File                      string
	RequestPos, ResponsePos   token.Pos
	RequestLine, ResponseLine int
	// contains filtered or unexported fields
}

Endpoint represents one HTTP endpoint

func (*Endpoint) GetFullPath

func (e *Endpoint) GetFullPath(splitter string, fn func(rawPath, path, placeholder string) string) string

GetFullPath returns the full path foe the endpoint

func (*Endpoint) GetParent

func (e *Endpoint) GetParent() *Group

GetParent returns the parent Group

type Group

type Group struct {
	ImportPath    string
	RawPath, Path string
	Dir           string
	Placeholder   string
	ParsedTypes   map[string]go2tstypes.Type

	Children  []*Group
	Endpoints []*Endpoint
	// contains filtered or unexported fields
}

Group is a layer for endpoints

func Parse

func Parse(dir string) (*Group, error)

Parse parses

func (*Group) GetFullPath

func (g *Group) GetFullPath(splitter string, fn func(rawPath, path, placeholder string) string) string

GetFullPath returns the full path foe the endpoint

func (*Group) GetParent

func (g *Group) GetParent() *Group

GetParent returns the parent Group

type MethodType

type MethodType string

MethodType represents methods for HTTP

const (
	// GET is GET method for HTTP
	GET MethodType = "GET"
	// POST is POST method for HTTP
	POST MethodType = "POST"
	// PUT is PUT method for HTTP
	PUT MethodType = "PUT"
	// DELETE is method for HTTP
	DELETE MethodType = "DELETE"
	// PATCH is method for HTTP
	PATCH MethodType = "PATCH"
)