pippo 0,1 editorconfig travis-ci

Micro Java Web Framework

3 years after

Micro Java Web Framework

Join the chat at https://gitter.im/decebals/pippo Travis CI Build Status Coverage Status Maven Central

It's an open source (Apache License) micro web framework in Java, with minimal dependencies and a quick learning curve.
The goal of this project is to create a micro web framework in Java that should be easy to use and hack.

Sample code

First we must create an Application and add some routes:

public class BasicApplication extends Application {

    @Override
    protected void onInit() {
        // send 'Hello World' as response
        GET("/", (routeContext) -> routeContext.send("Hello World"));

        // send a file as response
        GET("/file", (routeContext) -> routeContext.send(new File("pom.xml")));

        // send a json as response
        GET("/json", (routeContext) -> {
            Contact contact = createContact();
            routeContext.json().send(contact);
        });

        // send xml as response
        GET("/xml", (routeContext) -> {
            Contact contact = createContact();
            routeContext.xml().send(contact);
        });

        // send an object and negotiate the Response content-type, default to XML
        GET("/negotiate", (routeContext) -> {
            routeContext.xml().negotiateContentType().send(contact);
        });

        // send a template as response
        GET("/template", (routeContext) -> {
            routeContext.setLocal("greeting", "Hello");
            routeContext.render("hello");        
        });
    }

    private Contact createContact() {
        return new Contact()
            .setId(12345)
            .setName("John")
            .setPhone("0733434435")
            .setAddress("Sunflower Street, No. 6"); 
    }

}

where Contact is a simple POJO:

public class Contact  {

    private int id;
    private String name;
    private String phone;
    private String address;

    // getters and setters

}

The second step is to choose your favorite server, template engine and content type engine.
For example, I will choose Jetty as server, Freemarker as template engine, Jackson as JSON engine and JAXB as XML engine.
My Maven pom.xml looks like:

<dependency>
    <groupId>ro.pippo</groupId>
    <artifactId>pippo-core</artifactId>
    <version>${pippo.version}</version>
</dependency>

<dependency>
    <groupId>ro.pippo</groupId>
    <artifactId>pippo-freemarker</artifactId>
    <version>${pippo.version}</version>
</dependency>

<dependency>
    <groupId>ro.pippo</groupId>
    <artifactId>pippo-jackson</artifactId>
    <version>${pippo.version}</version>
</dependency>

The last step it's to start Pippo with your application as parameter:

public class BasicDemo {

    public static void main(String[] args) {
        Pippo pippo = new Pippo(new BasicApplication());
        pippo.start();
    }

}

Pippo launches the embedded web server (found in your classpath) and makes the application available on port 8338 (default value). Open your internet browser and check the routes declared in Application:

  • http://localhost:8338
  • http://localhost:8338/file
  • http://localhost:8338/json
  • http://localhost:8338/xml
  • http://localhost:8338/negotiate
  • http://localhost:8338/template

Documentation

Documentation is available on pippo.ro

Demo

Demo applications are available on pippo-demo
For a real life application built with Pippo please look at Web Accounting - Pippo Demo

Related Repositories

awesome-java

awesome-java

A curated list of awesome frameworks, libraries and software for the Java progra ...

awesome-java-cn

awesome-java-cn

Java资源大全中文版,包括开发库、开发工具、网站、博客、微信、微博等,由伯乐在线持续更新。 ...

useful-java-links

useful-java-links

A list of useful Java frameworks, libraries, software and hello worlds examples ...

awesome-minimalist

awesome-minimalist

A list of awesome minimalist frameworks (simple and lightweight). ...

ListOfMinimalistFrameworks

ListOfMinimalistFrameworks

A list of minimalist frameworks (simple and lightweight). ...


Top Contributors

decebals gitblit danjee ScienJus barrantesgerman gustavogalvan georgekankava balamaci lmicra sl33nyc anantheshadiga

Releases

-   release-0.9.1 zip tar
-   release-0.9.0 zip tar
-   release-0.8.0 zip tar
-   release-0.7.0 zip tar
-   release-0.6.1 zip tar
-   release-0.6.0 zip tar
-   release-0.5.0 zip tar
-   release-0.4.2 zip tar
-   release-0.4.1 zip tar
-   pippo-parent-0.4.0 zip tar
-   pippo-parent-0.3.0 zip tar
-   pippo-parent-0.2.0 zip tar
-   pippo-parent-0.1.0 zip tar