Documentation Home

API module

The API module adds many REST endpoints for interacting with the Broadleaf framework.

Compatibility

Module Version Compatible Broadleaf Versions
2.1.1-GA 5.1.0-GA
2.2.0-GA 5.2.0-GA
3.0.0-GA 6.0.0-GA
3.2.0-GA 6.1.0-GA
3.3.0-GA 6.2.0-GA

Module Dependencies

This module has no dependencies on other Broadleaf modules other than the core framework.

Module Installation

For detailed instructions on how to integrate the API module into your project, please see Module Installation.