Hypertext Application Language for Laravel

This library is modeled off of HAL in Apigility written by Zend and myself. Apigility in turn implements HAL according to the specification.

This library is written exclusively for Laravel. It implements the expected _links and _embedded sections as well as pagination links for supported collections. HAL provides HATEOAS (Hypertext As The Engine of Application State).

Installation

Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.

composer require api-skeletons/laravel-hal

This library is a collection of classes and does not require a ServiceProvider to be configured.

Versions

For PHP 7.0 - 7.3 use version 1.0. For PHP 7.4+ and Laravel 8.0 use up to 3.0.4. For PHP 8.0+ and Laravel 8.0+, use the latest version.

With Thanks

This work was inspired by an article written by Giulio Troccoli-Allard: Using HAL in content APIs

• Overview
  • Hydrators
  • Hydrator Manager
  • ApiSkeletons\Laravel\HAL\Resource
  • Abstract Classes
• Configuration
• Links
  • Self Link
  • Related Link
  • Complex Link
• Embedded Resources
  • Embedding Resources
• Collecitons and Paginated HAL
  • Collections
  • Pagination
• Specifying a Custom Hydrator For Extracting
  • Dependency Injection
  • Wildcard Hydrator
  • Embedded Resources
  • Pagination
  • Pivot Data
• Manually Creating Resources

---

This is documentation for Hypertext Application Language for Laravel. If you find this useful please add your ★ star to the project.