generator

Documentation

Index

• func Gen(docs []APIDoc, filename string)
• func ParsePackagesFromDir(dirpath string)
• func Scan(currpath string, filename string) (result *[]APIDoc, err error)
• type APIDoc
• type Param

Functions

func Gen

func Gen(docs []APIDoc, filename string)

Gen genera apidoc like doc

func ParsePackagesFromDir

func ParsePackagesFromDir(dirpath string)

ParsePackagesFromDir parsePackagesFromDir

func Scan

func Scan(currpath string, filename string) (result *[]APIDoc, err error)

Scan scan file

Types

type APIDoc

type APIDoc struct {
	IsSuccessArray bool
	Method         string
	Path           string
	Title          string
	APIName        string
	Group          string
	Version        string
	Params         map[string]Param
	Success        map[string]Param
}

APIDoc entity

type Param

type Param struct {
	Name        string
	Type        string
	Description string
	Child       []Param
}

Param stands for param