Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EndpointDef ¶
type EndpointDef struct {
Method string `json:"method"`
Path string `json:"path"`
Summary string `json:"summary"`
RequestBody map[string]any `json:"requestBody,omitempty"`
ResponseBody map[string]any `json:"responseBody,omitempty"`
}
EndpointDef represents a single scraped OpenAPI endpoint
type FileExtractResult ¶
type FileExtractResult struct {
File string
Endpoints []EndpointDef
Error error
}
FileExtractResult holds the endpoints found in one specific file
type IgnoreMatcher ¶
type IgnoreMatcher struct {
// contains filtered or unexported fields
}
IgnoreMatcher holds gitignore patterns and evaluates if a file should be ignored
func NewIgnoreMatcher ¶
func NewIgnoreMatcher(dir string) (*IgnoreMatcher, error)
NewIgnoreMatcher creates a new matcher from a .gitignore file
type OasDocument ¶
type OasDocument struct {
OpenAPI string `yaml:"openapi"`
Info OasInfo `yaml:"info"`
Paths map[string]OasPathItem `yaml:"paths"`
}
OasDocument represents a top-level OpenAPI 3.1 spec
type OasMediaType ¶
type OasOperation ¶
type OasOperation struct {
Summary string `yaml:"summary,omitempty"`
RequestBody *OasRequestBody `yaml:"requestBody,omitempty"`
Responses map[string]OasResponse `yaml:"responses"`
}
type OasPathItem ¶
type OasPathItem map[string]OasOperation // "get", "post", etc. -> OasOperation
type OasRequestBody ¶
type OasRequestBody struct {
Content map[string]OasMediaType `yaml:"content"`
}
type OasResponse ¶
type OasResponse struct {
Description string `yaml:"description"`
Content map[string]OasMediaType `yaml:"content,omitempty"`
}
type ProjectFramework ¶
type ProjectFramework struct {
Language string `json:"language"`
Framework string `json:"framework"`
}
ProjectFramework contains LLM-detected metadata about the project
type RouterFile ¶
RouterFile contains the path to a routing file and some metadata about it
type Scanner ¶
type Scanner struct {
// contains filtered or unexported fields
}
Scanner orchestrates the codebase scan
func NewScanner ¶
NewScanner creates a new Scanner instance
Click to show internal directories.
Click to hide internal directories.