specscanner

package

v0.0.0-...-abd191e Latest Latest Go to latest Published: Mar 25, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package specscanner provides a generic way to scan a swagger spec. It provides a Handler interface that can be implemented to receive callbacks

This section is empty.

This section is empty.

func Scan(specData []byte, handler Handler, logger *zap.Logger) error

Scan will scan the given spec data and call the implemented methods on the given handler specData should be the raw bytes of the swagger spec JSON

type Handler interface {
	StartScan(apiSpec *spec.Swagger) error
	EndScan() error
}

Handler is the interface that should be implemented to receive callbacks when scanning a swagger spec.

type OperationHandler interface {
	StartOp(op string, opSpec *spec.Operation) error
	EndOp() error
}

OperationHandler is an optional interface that can be implemented to receive callbacks when the scanner encounters a new operation.

type ParamHandler interface {
	StartParam(getSpec *spec.Parameter) error
	EndParam() error
}

ParamHandler is an optional interface that can be implemented to receive callbacks when the scanner encounters a new parameter.

type PathHandler interface {
	StartPath(path string, pathSpec spec.PathItem) error
	EndPath() error
}

PathHandler is an optional interface that can be implemented to receive callbacks when the scanner encounters a new path.

type ResponseHandler interface {
	StartResponse(statusCode int, getSpec *spec.Response) error
	EndResponse() error
}

ResponseHandler is an optional interface that can be implemented to receive callbacks when the scanner encounters a new response.