openapi

Documentation

Index

• type OpenAPIGenerator
  • func NewOpenAPIGenerator(store *snapshot.SnapshotStore) *OpenAPIGenerator
  • func (g *OpenAPIGenerator) Generate() (map[string]interface{}, error)
  • func (g *OpenAPIGenerator) InferPathParams(urls []string) []PathTemplate
  • func (g *OpenAPIGenerator) WriteYAML(w io.Writer) error
• type PathTemplate

Types

type OpenAPIGenerator

type OpenAPIGenerator struct {
	Store *snapshot.SnapshotStore
}

OpenAPIGenerator builds an OpenAPI 3.0 spec from recorded snapshots.

func NewOpenAPIGenerator

func NewOpenAPIGenerator(store *snapshot.SnapshotStore) *OpenAPIGenerator

NewOpenAPIGenerator creates an OpenAPIGenerator backed by the given store.

func (*OpenAPIGenerator) Generate

func (g *OpenAPIGenerator) Generate() (map[string]interface{}, error)

Generate reads all snapshots and produces an OpenAPI 3.0 spec as a nested map.

func (*OpenAPIGenerator) InferPathParams

func (g *OpenAPIGenerator) InferPathParams(urls []string) []PathTemplate

InferPathParams takes a list of URL paths with the same segment count and detects segments that vary across the set, replacing them with parameter placeholders.

func (*OpenAPIGenerator) WriteYAML

func (g *OpenAPIGenerator) WriteYAML(w io.Writer) error

WriteYAML generates the OpenAPI spec and writes it as YAML to w.

type PathTemplate

type PathTemplate struct {
	Template string   // e.g., "/users/{id}"
	Params   []string // e.g., ["id"]
}

PathTemplate represents a parameterized URL path.