A lightweight, open-source Salesforce REST framework built with Apex to simplify the creation of REST APIs for Salesforce. Designed for scalability and easy integration, this framework helps developers quickly set up customizable REST endpoints to connect Salesforce with external systems.
It includes interfaces for routing, response handling, error management, and logging, along with core components for processing RESTful requests.
- Business Logic Focused: Allows developers to concentrate on solving business challenges while the framework handles routing, error management, and API structure.
- Customizable: Easily define and manage REST endpoints.
- Scalable: Supports enterprise-level integrations.
- Developer-Friendly: Clear structure and easy-to-use API.
- 1st option
- Clone or download this repository.
- Deploy the source code to your Salesforce org using your preferred deployment tool (e.g., Salesforce CLI, Workbench, or IDE).
- 2nd option
- Use the "Deploy to Salesforce" button to deploy the framework to your target organization.
A comprehensive Developer Guide is available here. Follow the link for detailed instructions and advanced usage examples.
The API Reference documentation is available here. It provides detailed descriptions of all classes, methods, and endpoints included in the framework.
We welcome contributions! Here’s how you can get started:
-
🍴 Fork the Repository
-
🌱 Create a New Branch
Work on your changes in a separate branch.
Follow the branch naming conventions:
- ✨ For features:
feature/<branch-name> - 🐛 For bug fixes:
bugfix/<branch-name> - 📚 For documentation:
doc/<branch-name>
- 🔧 Make Changes and Test
Implement your changes and ensure everything works.
- 🚀 Push Your Changes
Push your branch to your forked repository:
git push origin your-branch-name
- 📬 Submit a Pull Request
Open a pull request to the develop branch with a clear description of your changes.
This project is licensed under the MIT License - see the LICENSE file for details.
Have questions or feedback? Reach out to the repository owner or start a discussion in the Issues tab.