The goal of this lab is to add support of restful webservices for an application.
In order to initialize your project, we provide a tiny sample project to show how to run an JAX-RS application, embedded in Undertow app server, fired up in a main() method.
Undertow is a flexible performant web server written in java, providing both blocking and non-blocking API’s based on NIO.
Undertow has a composition based architecture that allows you to build a web server by combining small single purpose handlers. The gives you the flexibility to choose between a full Java EE servlet 3.1 container, or a low level non-blocking handler, to anything in between.
Undertow is designed to be fully embeddable, with easy to use fluent builder APIs. Undertow’s lifecycle is completely controlled by the embedding application.
Fork this project.
Just build the project:
mvn clean install
and launch the server:
java -jar target/server-test-1.0-SNAPSHOT.jar
You can test the service using to get a person
curl -H "Content-Type: application/json" -X GET http://localhost:8080/status/person
to insert a Person
curl -H "Content-Type: application/json" -X POST -d '{"name":"test","firstName":"t"}' http://localhost:8080/status/person
You can import this maven project in your favorite IDE.
Using this example, select an example of RestServices you could build.
You can have three choices.
-
You can re-implement swapi
-
You can provide a rest access within the Borg calendar. In this case, you need to install the lombok tool for your IDE .
-
you can provide you own Rest API for your tweeter account http://twitter4j.org/en/index.html.
The goal is to design a clean CRUD API fo a business layer that allows to interact with your application using retful services.
Maxime provides a complete example with an integration with JPA. https://github.com/maxleiko/taa-jpa if require.
In following this guide. Integrate swagger with your API
https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-RESTEasy-2.X-Project-Setup-1.5
Look at the three files to understand how you can integrate swagger to your application. Of course, when you go in production, the delivery of swagger-ui static content (JS, html, images)must not be provided by undertow but it must be provided by your nginx or your apache webserver.