API Reference (HTTP-based REST 🛌)

The hyper Service Framework is built using the Ports and Adapters architecture, and so can be presented (and consumed) using any hyper App implementation.

However, a common presentation of hyper is an HTTP-based RESTful API. The hyper Core team maintains an HTTP-based RESTful hyper hyper App implementation, using the popular Web Server framework express.

This hyper App exposes each of the core hyper Services as a set of REST resources:

• Data: hyper Data Services available on the hyper Server
• Cache: hyper Cache Services available on the hyper Server
• Storage: hyper Storage Services available on the hyper Server
• Queue: hyper Queue Services available on the hyper Server
• Search: hyper Search Services available on the hyper Server

INFO

Be sure to include any appropriate authN/Z on the request. See Securing your hyper Server