Skip to content

Latest commit

 

History

History
86 lines (58 loc) · 3.23 KB

README.md

File metadata and controls

86 lines (58 loc) · 3.23 KB
Raw

Lamebda logo

Maven Central Hex.pm

A simple, powerful, plugin system for adding new API endpoints or custom functionality to you Spring project. Oftentimes there are conflicting requirements from different clients utilizing a common main application. The required custom functionality needed is often easy to do with a few lines of code, but is not acceptable to add to your main code-base. With Lamebda you can load either precompiled or source files (Groovy/Java) for adding custom functionality.

It Really Whips The Lambda's Ass!

Example use-cases

  • Ad-hoc API services and integration projects - Changes in the integration code can evolve freely from the core service
  • Transactional support across multiple API calls
  • Batch multiple API calls to avoid chatty data exchange
  • API prototyping
  • A powerful support tool for extracting data or changing state (think JMX on steroids)

Getting started

Integrating with your project

Usage with Spring Boot and Spring MVC

Note:

1.x releases are for Spring Boot 2.x.

2.x releases are for Spring Boot 3.x.

Add dependency to your pom.xml

<dependency>
    <groupId>com.ethlo.lamebda</groupId>
    <artifactId>lamebda-spring-web-starter</artifactId>
    <version>2.0.1</version>
</dependency>

Add the following properties to your applications application.properties|yaml:

lamebda.enabled=true
lamebda.root-directory=/var/lib/lamebda
lamebda.request-path=/gateway

Project configuration

project.properties

  • project.name - Human-readable name of the project. Optional.
  • project.base-packages - The base packages that Spring IOC container is scanning for services and controllers.
  • project.root-request-path-enabled - Default is true. If you set this to false, the URLs in this project will not have the prepended gateway path.
  • project.url-prefix-enabled - Default is true. If you set this to false the URLs in this project will not have the prepended project alias.

Setup a project folder

Create a project folder. This folder is a logical grouping for your API functions. We will go with the creative choice test for now. We now have the folder /var/lib/lamebda/test.

Add your first script

  1. Create a folder for the functions in the test project: /var/lib/lamebda/test/src/main/groovy/com/acme

  2. Add a simple script in the scripts folder:

@RestController
class MyController {
    @GetMapping("/my/{id}")
    def get(@PathVariable("id") int id) {
        return [requested: id]
    }
}

Please note that you can also write code in good ol' Java! Make sure you then put it in src/main/java/com/acme.

Add com.acme as base-package in your project.properties: project.base-packages=com.acme

Access your first function

Your function should be available under /gateway/test/my/123

Built in functions

  • /<servlet>/gateway - Status page showing your projects