api_spec_ingest

package

v0.5.2 Latest Latest Go to latest Published: Oct 3, 2026 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vigolium/vigolium

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	ModuleID    = "api-spec-ingest"
	ModuleName  = "API Spec Ingest"
	ModuleShort = "Discovers API specs (OpenAPI/Swagger/Postman) and ingests endpoints for scanning"

	ModuleDesc = `` /* 668-byte string literal not displayed */

	ModuleConfirmation = "An API specification document was found and successfully parsed. " +
		"Extracted endpoints have been ingested into the scanning pipeline."
)

Variables ¶

View Source

var (
	ModuleSeverity   = severity.Info
	ModuleConfidence = severity.Firm
	ModuleTags       = []string{"api", "discovery", "spec-ingest", "light"}
)

Functions ¶

This section is empty.

Types ¶

type Module ¶

type Module struct {
	modkit.BaseActiveModule
	// contains filtered or unexported fields
}

Module is the active API spec ingest scanner.

func New ¶

func New() *Module

New creates a new API Spec Ingest module.

func (*Module) CanProcess ¶

func (m *Module) CanProcess(ctx *httpmsg.HttpRequestResponse) bool

CanProcess requires a response to be attached and a valid URL.

func (*Module) IncludesBaseCanProcess ¶

func (m *Module) IncludesBaseCanProcess() bool

IncludesBaseCanProcess returns false because we override CanProcess entirely.

func (*Module) ScanPerRequest ¶

func (m *Module) ScanPerRequest(
	ctx *httpmsg.HttpRequestResponse,
	httpClient *http.Requester,
	scanCtx *modkit.ScanContext,
) ([]*output.ResultEvent, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL