parser

type ApiDocSpec struct {
	Service       string
	Title         string
	Version       string
	Description   string
	BaseURL       string
	Groups        []*ApiGroupSpec
	UngroupedApis []*ApiSpec
	TotalCount    int
}

type ApiGroupSpec struct {
	Group       string
	Title       string
	Description string
	Apis        []*ApiSpec
	Order       int //sort
}

type ApiParameterSpec struct {
	Name        string
	DataType    string
	Required    bool
	Description string
	Validate    string
	Example     string
	// contains filtered or unexported fields
}

type ApiRequestSpec struct {
	Parameters map[string]*ApiParameterSpec
	Accept     string //accept format
	Schema     *TypeSchema
	// contains filtered or unexported fields
}

type ApiResponseSpec struct {
	StatusCode  int
	Format      string //json xml
	Schema      *TypeSchema
	Description string
	IsMock      bool
	// contains filtered or unexported fields
}

type ApiSpec struct {
	Title       string
	HTTPMethod  string
	Api         string
	Version     string
	Accept      string //json,xml,form
	Format      string //json,xml
	Description string
	Author      string
	Deprecated  bool
	Group       string
	Responses   []*ApiResponseSpec
	Requests    ApiRequestSpec
	Order       int //sort
	// contains filtered or unexported fields
}

type AstFileInfo struct {
	// File ast.File
	File *ast.File
	// Path the path of the ast.File
	Path string
	// PackagePath package import path of the ast.File
	PackagePath string
}

type Operation struct {
	ApiSpec
	// contains filtered or unexported fields
}

type PackageDefinitions struct {
	// files in this package, map key is file's relative path starting package path
	Files map[string]*ast.File

	// definitions in this package, map key is typeName
	TypeDefinitions map[string]*TypeSpecDef

	// package name
	Name string
}

type PackagesDefinitions struct {
	// contains filtered or unexported fields
}

type Parser struct {
	// contains filtered or unexported fields
}

type TypeSchema struct {
	Name        string //xxRequest, xxResponse, for example: RegisterRequest
	Type        string //int, string, bool, object, array, any
	FullName    string
	PkgPath     string //for example: github.com/alovn/apidocgen/examples/svc-user/handler
	FullPath    string //for example: github.com/alovn/apidocgen/examples/svc-user/handler.RegisterRequest
	Comment     string
	ArraySchema *TypeSchema
	Properties  map[string]*TypeSchema //object
	Parent      *TypeSchema
	TagValue    string
	// contains filtered or unexported fields
}

type TypeSpecDef struct {
	// ast file where TypeSpec is
	File *ast.File

	// the TypeSpec of this type definition
	TypeSpec *ast.TypeSpec

	// path of package starting from under ${GOPATH}/src or from module path in go.mod
	PkgPath string
}