apisurface

package

v1.0.2 Latest Latest Go to latest Published: Sep 30, 2026 License: MIT Imports: 11 Imported by: 0

Details

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

Repository

github.com/open-rails/authkit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package apisurface lists the Go API that AuthKit v1 covers (docs/stability.md), one feature per line: every exported constant, variable, function, type, field (with its struct tag) and method of the covered packages. api/go.txt holds the list; go generate ./internal/httpapi rewrites it and TestGoAPISurface fails when it is stale.

Constants ¶

View Source

const (
	// Module is AuthKit's module path.
	Module = "github.com/open-rails/authkit"
	// File is where the list lives, relative to the repository.
	File = "api/go.txt"
)

Variables ¶

View Source

var ErrStale = errors.New(File + " is stale: run go generate ./internal/httpapi")

ErrStale reports a stale api/go.txt.

View Source

var Packages = []string{
	"", "adapters/fiber", "adapters/gin", "adapters/twilio", "authtest",
	"devicekey", "iam", "keys", "provider", "verify",
}

Packages are the covered packages, relative to Module.

Functions ¶

This section is empty.

Types ¶

type Surface ¶

type Surface struct {
	// Features is one sorted line per exported feature.
	Features []string
	// Leaks are internal types the covered API reaches without a covered
	// package naming them by an alias.
	Leaks []string
}

Surface is the covered API.

func Load ¶

func Load() (*Surface, error)

Load type-checks the covered packages from their export data (go list -export) and lists their features. It runs the go command in the working directory, which must be inside the module.

func (*Surface) Text ¶

func (s *Surface) Text() []byte

Text is the list as api/go.txt holds it.

Source Files ¶

View all Source files

apisurface.go

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