Wanbli

A small framework for creating simple JSON REST applications using the Dictu programming language.

Wanbli aims to be as simple as possible. Responses are assumed to be JSON but if it's just a single string returned, the string is returned. Any other datatype gets JSON encoded.

Getting Started

Import the framework:

from "wanbli.du" import Wanbli;

Initialize the framework by calling the Wanbli function. It takes the listening address and port.

const wanbli = Wanbli("0.0.0.0", 8080);

Setup a Controller

Wanbli uses classes, methods, and annotations to drive primary functionality. Wanbli will automatically take all types, including classes, and return them via JSON encoding. Strings are returned as is. The example below shows how a class can be configure to handle requests.

class ResponseData {
    var name = "";
    var age = 0;
    init(var name, var age) {}
}

@Controller("/api/v1/widget")
class Widget {
    init() {
        this.dataStore = {};
    }

    @Post
    new(request) {
        this.dataStore = this.dataStore.merge(request.body);
        return [this.dataStore];
    }

    @Put
    update(request) {
        this.dataStore = this.dataStore.merge(request.body);
        return [this.dataStore];
    }

    @Get
    retrieve(request) {
        if (request.query.exists("id")) {
            const key = request.query.get("id");
            return {
                key: this.dataStore.get(key)
            };
        }
        
        return {};
    }

    @Get("/all")
    all(request) {
        return this.dataStore;
    }

    @Get("/serialized-class")
    serializedClass() {
        return ReturnData("Widget!", 99);
    }
}

Middleware

Wanbli comes with a number of middlewares.

Authentication

Token Auth

To use token authentication on 1 or more of your endpoints, instantiate a new TokenAuth value with your preferred header value and token, and then register the middleware with Wanbli.

const tokenAuth = TokenAuth("X-Wanbli-Auth", "asdf");
wanbli.addMiddleware(tokenAuth);

To use token authentication on your endpoint, apply the @Secure("TokenAuth") annotation with the "TokenAuth" field indication the type of security for the endpoint.

@Get
@Secure("TokenAuth")
retrieve(request) {
    ...
}

Contributions

File Issue with details of the problem, feature request, etc.
Submit a pull request and include details of what problem or feature the code is solving or implementing.

briandowns / wanbli