related_apis.go

package babyapi

import (
	"fmt"
	"net/http"

	"github.com/go-chi/chi/v5"
)

// RelatedAPI declares a subset of methods from the API struct that are required to enable
// nested/parent-child API relationships
type RelatedAPI interface {
	Router() (chi.Router, error)
	Route(chi.Router) error
	Base() string
	Name() string
	GetIDParam(*http.Request) string
	Parent() RelatedAPI
	CreateClientMap(*Client[*AnyResource]) map[string]*Client[*AnyResource]
}

type relatedAPI interface {
	RelatedAPI

	setParent(relatedAPI)
	getCustomResponseCodeMap() map[string]int
	isRoot() bool
}

// Parent returns the API's parent API
func (a *API[T]) Parent() RelatedAPI {
	return a.parent
}

// GetParentIDParam reads the URL param from the request to get the ID of the parent resource
func (a *API[T]) GetParentIDParam(r *http.Request) string {
	return a.parent.GetIDParam(r)
}

// AddNestedAPI adds a child API to this API and initializes the parent relationship on the child's side
func (a *API[T]) AddNestedAPI(childAPI RelatedAPI) *API[T] {
	a.panicIfReadOnly()

	relAPI, ok := childAPI.(relatedAPI)
	if !ok {
		a.errors = append(a.errors, fmt.Errorf("AddNestedAPI: incompatible type for child API: %T", childAPI))
		return a
	}

	a.subAPIs[childAPI.Name()] = relAPI
	relAPI.setParent(a)

	return a
}

func (a *API[T]) setParent(parent relatedAPI) {
	a.parent = parent
}

func (a *API[T]) getCustomResponseCodeMap() map[string]int {
	return a.responseCodes
}

func (a *API[T]) isRoot() bool {
	return a.rootAPI
}