hal

Documentation

Index

• type ApiProblem
  • func NewApiProblem(statusCode int, err error) ApiProblem
• type Collection
  • func NewCollection[T any](resources []T, q query.Builder, linkUrl *url.URL) Collection[[]T]
• type Link
  • func NewLink(href string) Link
• type Links
• type Message
  • func NewMessage(msg, path string, embedded ...any) Message
• type Resource
  • func NewResource(selfHref string, embedded ...any) Resource
• type ResourceEmbeds
  • func NewEmbeds[T any](embeds T) *ResourceEmbeds[T]
• type ResourceLinks
  • func NewCollectionLinks(q query.Builder, linkUrl *url.URL) *ResourceLinks
  • func NewLinks() *ResourceLinks
  • func NewResourceLinks(selfHref string) *ResourceLinks
  • func (l *ResourceLinks) AddLink(key string, link Link) *ResourceLinks

Types

type ApiProblem

type ApiProblem struct {
	DescribedBy string `json:"describedBy"`          // a URL to a document describing the error condition (required)
	Title       string `json:"title"`                // a brief title for the error condition (required)
	HttpStatus  int    `json:"httpStatus,omitempty"` // the HTTP status code for the current request (optional)
	Details     string `json:"details,omitempty"`    // error details specific to this request (optional)
	SupportID   string `json:"supportId,omitempty"`  // a URL to the specific problem occurrence (e.g., to a log message) (optional)
}

ApiProblem describes an API error according to the API-Problem proposed standard. https://phlyrestfully.readthedocs.io/en/latest/problems.html https://datatracker.ietf.org/doc/html/draft-nottingham-http-problem-02

func NewApiProblem

func NewApiProblem(statusCode int, err error) ApiProblem

type Collection

type Collection[T any] struct {
	*query.Pagination
	*ResourceEmbeds[T]
	*ResourceLinks
}

Collection represents a paginated list of API content. https://phlyrestfully.readthedocs.io/en/latest/halprimer.html#collections

func NewCollection

func NewCollection[T any](resources []T, q query.Builder, linkUrl *url.URL) Collection[[]T]

type Link

type Link struct {
	Href string `json:"href"`
}

func NewLink

func NewLink(href string) Link

type Links

type Links map[string]Link

type Message

type Message struct {
	Message string `json:"message"`
	Resource
}

func NewMessage

func NewMessage(msg, path string, embedded ...any) Message

type Resource

type Resource struct {
	*ResourceEmbeds[any]
	*ResourceLinks
}

Resource represents an individual piece of content exposed by the API. https://phlyrestfully.readthedocs.io/en/latest/halprimer.html#resources

func NewResource

func NewResource(selfHref string, embedded ...any) Resource

type ResourceEmbeds

type ResourceEmbeds[T any] struct {
	Embeds T `json:"_embedded,omitempty" gorm:"embedded"`
}

func NewEmbeds

func NewEmbeds[T any](embeds T) *ResourceEmbeds[T]

type ResourceLinks

type ResourceLinks struct {
	Links `json:"_links,omitempty" gorm:"-"`
}

func NewCollectionLinks

func NewCollectionLinks(q query.Builder, linkUrl *url.URL) *ResourceLinks

func NewLinks

func NewLinks() *ResourceLinks

func NewResourceLinks

func NewResourceLinks(selfHref string) *ResourceLinks

func (*ResourceLinks) AddLink

func (l *ResourceLinks) AddLink(key string, link Link) *ResourceLinks