Rename type Intercepter to RouteIndex

apidoc/example_test.go

@@ -8,11 +8,11 @@ import (
 	"github.com/gregoryv/web/apidoc"
 )
 
-func ExampleNewIntercepter() {
+func ExampleDoc_Document() {
 	mux := http.NewServeMux()
 	x := apidoc.NewDoc(mux)
 
-	// use the intercepter when defining routes
+	// use the RouteIndex when defining routes
 	mux.Handle("/", someHandler)
 	x.Document("/")
 
@@ -26,7 +26,7 @@ func ExampleNewIntercepter() {
 
 func ExampleIntercepter_Defines() {
 	mux := http.NewServeMux()
-	x := apidoc.NewIntercepter()
+	x := apidoc.NewRouteIndex()
 
 	mux.Handle("/", someHandler)
 	x.Document("/")

apidoc/package.go

@@ -18,8 +18,8 @@ import (
 // NewDoc returns a documentation generator for the given router
 func NewDoc(router http.Handler) *Doc {
 	return &Doc{
-		router:      router,
-		Intercepter: NewIntercepter(),
+		router:     router,
+		RouteIndex: NewRouteIndex(),
 	}
 }
 
@@ -30,7 +30,8 @@ type Doc struct {
 
 	router http.Handler
 
-	*Intercepter
+	// RouteIndex is used to index any routes you wish to document.
+	*RouteIndex
 }
 
 // NewRequest returns a <pre> element of a request based on the

apidoc/intercepter.go → apidoc/routeindex.go

@@ -10,36 +10,36 @@ import (
 // NewIntercepter returns a wrapper for the underlying handler
 // registering all routes being defined. It can then be used to add
 // more documentation to each route.
-func NewIntercepter() *Intercepter {
-	return &Intercepter{
+func NewRouteIndex() *RouteIndex {
+	return &RouteIndex{
 		index:      make(map[string]struct{}),
 		ErrHandler: &logIt{},
 	}
 }
 
-type Intercepter struct {
+type RouteIndex struct {
 	routes []string
 	index  map[string]struct{}
 
 	// handles errors when calling method Defines
 	ErrHandler
 }
 
-func (d *Intercepter) Document(pattern string) {
+func (d *RouteIndex) Document(pattern string) {
 	key := WithMethod(pattern)
 	d.routes = append(d.routes, key)
 	d.index[key] = struct{}{}
 }
 
 // Routes returns a list of defined routes as "METHOD PATTERN"
-func (d *Intercepter) Routes() []string {
+func (d *RouteIndex) Routes() []string {
 	return d.routes
 }
 
 // Defines checks if the given pattern, [METHOD ]PATTERN, has not been
 // defined. Use it when documenting your routes.  The given error
 // handler is used to signal error, eg. using testing.T in a test.
-func (d *Intercepter) Defines(pattern string) {
+func (d *RouteIndex) Defines(pattern string) {
 	key := WithMethod(pattern)
 	// if the ErrHandler is e.g. testing.T
 	if eh, ok := d.ErrHandler.(interface{ Helper() }); ok {
@@ -53,7 +53,7 @@ func (d *Intercepter) Defines(pattern string) {
 }
 
 // Undocumented returns empty string if all routes are documented.
-func (d *Intercepter) Undocumented() string {
+func (d *RouteIndex) Undocumented() string {
 	if len(d.index) == 0 {
 		return ""
 	}

changelog.md

@@ -5,7 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## [unreleased]
 
-- Add type apidoc.Intercepter
+- Use type apidoc.Doc to index routes for additional documentation
 
 ## [0.26.1] 2024-03-22