internal

Documentation

Index

• func ParseDirForComments(directory string) (comments []string)
• type Component
  • func ParseSwagifyComment(comments []string) Component
• type MyField
• type MyStruct
  • func ParseDirForStructs(directory string, comments SwagifyComment) (myStructs []MyStruct)
• type SwagifyComment

Functions

func ParseDirForComments

func ParseDirForComments(directory string) (comments []string)

Types

type Component

type Component struct {
	Types map[string]SwagifyComment
}

func ParseSwagifyComment

func ParseSwagifyComment(comments []string) Component

this will return something like this: { map[parameter]: {map[<name>]: [line1, line2, ...], map[<name>]: [line1, line2, ...]} map[schema]: {map[<name>]: [line1, line2, ...], map[<name>]: [line1, line2, ...]} }

type MyField

type MyField struct {
	Name string
	Type string
	Tag  string
}

type MyStruct

type MyStruct struct {
	Name   string
	Fields []MyField
}

func ParseDirForStructs

func ParseDirForStructs(directory string, comments SwagifyComment) (myStructs []MyStruct)

this will take a list of "marked" (through comments) to parse and create a MyStruct structure based on the struct's content, used by "schema", see internal/schema/schema.go

type SwagifyComment

type SwagifyComment struct {
	Comments map[string][][]string
}