API Reference¶

type Tape struct {
    ID         string       `json:"id"`
    Route      string       `json:"route"`
    RecordedAt time.Time    `json:"recorded_at"`
    Request    RecordedReq  `json:"request"`
    Response   RecordedResp `json:"response"`
}

func NewTape(route string, req RecordedReq, resp RecordedResp) Tape

type RecordedReq struct {
    Method           string       `json:"method"`
    URL              string       `json:"url"`
    Headers          http.Header  `json:"headers"`
    Body             []byte       `json:"body"`
    BodyHash         string       `json:"body_hash"`
    BodyEncoding     BodyEncoding `json:"body_encoding,omitempty"`
    Truncated        bool         `json:"truncated,omitempty"`
    OriginalBodySize int64        `json:"original_body_size,omitempty"`
}

type RecordedResp struct {
    StatusCode       int          `json:"status_code"`
    Headers          http.Header  `json:"headers"`
    Body             []byte       `json:"body"`
    BodyEncoding     BodyEncoding `json:"body_encoding,omitempty"`
    Truncated        bool         `json:"truncated,omitempty"`
    OriginalBodySize int64        `json:"original_body_size,omitempty"`
}

type BodyEncoding string

const (
    BodyEncodingIdentity BodyEncoding = "identity" // UTF-8 text
    BodyEncodingBase64   BodyEncoding = "base64"   // binary content
)

func BodyHashFromBytes(b []byte) string // SHA-256 hex hash, empty for nil/empty input

type Recorder struct { /* unexported */ }

func NewRecorder(store Store, opts ...RecorderOption) *Recorder
func (r *Recorder) RoundTrip(req *http.Request) (*http.Response, error) // implements http.RoundTripper
func (r *Recorder) Close() error

type Proxy struct { /* unexported */ }

func NewProxy(l1, l2 Store, opts ...ProxyOption) *Proxy
func (p *Proxy) RoundTrip(req *http.Request) (*http.Response, error) // implements http.RoundTripper

type Server struct { /* unexported */ }

func NewServer(store Store, opts ...ServerOption) *Server
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) // implements http.Handler

type Sanitizer interface {
    Sanitize(Tape) Tape
}

type SanitizeFunc func(Tape) Tape

type Pipeline struct { /* unexported */ }

func NewPipeline(funcs ...SanitizeFunc) *Pipeline
func (p *Pipeline) Sanitize(t Tape) Tape // implements Sanitizer

const Redacted = "[REDACTED]"

func DefaultSensitiveHeaders() []string

type Matcher interface {
    Match(req *http.Request, candidates []Tape) (Tape, bool)
}

type MatcherFunc func(req *http.Request, candidates []Tape) (Tape, bool)
func (f MatcherFunc) Match(req *http.Request, candidates []Tape) (Tape, bool)

type MatchCriterion func(req *http.Request, candidate Tape) int

func DefaultMatcher() *CompositeMatcher          // MatchMethod + MatchPath
func ExactMatcher() Matcher                       // first method+path match
func NewCompositeMatcher(criteria ...MatchCriterion) *CompositeMatcher

type Store interface {
    Save(ctx context.Context, tape Tape) error
    Load(ctx context.Context, id string) (Tape, error)
    List(ctx context.Context, filter Filter) ([]Tape, error)
    Delete(ctx context.Context, id string) error
}

type Filter struct {
    Route  string
    Method string
}

var ErrNotFound = errors.New("httptape: tape not found")
var ErrInvalidID = errors.New("httptape: invalid tape ID")

func NewMemoryStore(opts ...MemoryStoreOption) *MemoryStore

func NewFileStore(opts ...FileStoreOption) (*FileStore, error)
func WithDirectory(dir string) FileStoreOption  // default: "fixtures"

func ExportBundle(ctx context.Context, s Store, opts ...ExportOption) (io.Reader, error)
func ImportBundle(ctx context.Context, s Store, r io.Reader) error

type Manifest struct {
    ExportedAt      time.Time `json:"exported_at"`
    FixtureCount    int       `json:"fixture_count"`
    Routes          []string  `json:"routes"`
    SanitizerConfig string    `json:"sanitizer_config,omitempty"`
}

type Config struct {
    Version string `json:"version"`
    Rules   []Rule `json:"rules"`
}

type Rule struct {
    Action  string   `json:"action"`
    Headers []string `json:"headers,omitempty"`
    Paths   []string `json:"paths,omitempty"`
    Seed    string   `json:"seed,omitempty"`
}

func LoadConfig(r io.Reader) (*Config, error)
func LoadConfigFile(path string) (*Config, error)
func (c *Config) Validate() error
func (c *Config) BuildPipeline() *Pipeline

const (
    ActionRedactHeaders = "redact_headers"
    ActionRedactBody    = "redact_body"
    ActionFake          = "fake"
)

type MockServer struct { *httptest.Server }

func Mock(stubs ...Stub) *MockServer

func When(m Method) *StubBuilder
func (b *StubBuilder) Respond(status int, body ...Body) *StubBuilder
func (b *StubBuilder) WithHeader(key, value string) *StubBuilder
func (b *StubBuilder) Build() Stub

// Method helpers
func GET(path string) Method
func POST(path string) Method
func PUT(path string) Method
func DELETE(path string) Method
func PATCH(path string) Method
func HEAD(path string) Method

// Body helpers
func JSON(s string) Body
func Text(s string) Body
func Binary(b []byte) Body

func LoadFixtures(dir string) (*FileStore, error)
func LoadFixturesFS(fsys fs.FS, dir string) (*MemoryStore, error)