https://github.com/akohan91/libak-salesforce-rest-api-framework
A lightweight Salesforce REST framework designed to simplify API development with Apex. Supports scalable integrations and customizable endpoints.
https://github.com/akohan91/libak-salesforce-rest-api-framework
apex apex-framework api-design api-development developer-tools integration libak open-source rest-api salesforce-platform salesforce-rest-framework salesfroce webservices
Last synced: 4 months ago
JSON representation
A lightweight Salesforce REST framework designed to simplify API development with Apex. Supports scalable integrations and customizable endpoints.
- Host: GitHub
- URL: https://github.com/akohan91/libak-salesforce-rest-api-framework
- Owner: akohan91
- License: mit
- Created: 2024-06-05T13:20:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T14:35:22.000Z (5 months ago)
- Last Synced: 2026-01-17T04:41:49.726Z (5 months ago)
- Topics: apex, apex-framework, api-design, api-development, developer-tools, integration, libak, open-source, rest-api, salesforce-platform, salesforce-rest-framework, salesfroce, webservices
- Language: Apex
- Homepage:
- Size: 1.16 MB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RestFramework - Salesforce Apex REST Framework
---
- [Features](#features)
- [UML Diagram](#uml-diagram)
- [Getting Started](#getting-started)
- [Contribution](#contribution)
- [License](#license)
- [Contact](#contact)
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.
## 💡 Features
- **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.
## UML Diagram
## Getting Started
### 🚀 Installation
- **1st option**
1. Clone or download this repository.
2. Deploy the source code to your Salesforce org using your preferred deployment tool (e.g., Salesforce CLI, Workbench, or IDE).
- **2nd option**
1. Use the "Deploy to Salesforce" button to deploy the framework to your target organization.
### 📘 Developer guide
A comprehensive Developer Guide is available [here](Developer_Guide.md). Follow the link for detailed instructions and advanced usage examples.
### 📕 API Reference
The API Reference documentation is available [here](API_Reference.md). It provides detailed descriptions of all classes, methods, and endpoints included in the framework.
## 🤝 Contribution
We welcome contributions! Here’s how you can get started:
1. **🍴 Fork the Repository**
2. **🌱 Create a New Branch**
Work on your changes in a separate branch.
Follow the branch naming conventions:
- ✨ For features: `feature/`
- 🐛 For bug fixes: `bugfix/`
- 📚 For documentation: `doc/`
3. **🔧 Make Changes and Test**
Implement your changes and ensure everything works.
4. **🚀 Push Your Changes**
Push your branch to your forked repository:
`git push origin your-branch-name`
5. **📬 Submit a Pull Request**
Open a pull request to the develop branch with a clear description of your changes.
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 📧 Contact
Have questions or feedback? Reach out to the repository owner or start a discussion in the Issues tab.