Restful-api

A sample RESTful api implemented with Resteasy and usage example of Junit4, Arquillian, RestAssured, Swagger

Application Server
Maven
- Build
- Integration Tests
  - Explain
ApiDocs
- Swagger JSON
- Swagger UI

Aplication Server

This sample use Wildfly 11 such as ServletContainer and JEE full implementation

Maven

Build

This project is built-in with maven throught the goal

mvn package

Integration Tests

The integration tests uses Arquillian Chameleon to provide a container instance in tests scope and RestAssured to verify the Rest API

To execute tests run the goal

mvn verify

Explainning a little bit more

When integration-tests goal starts, the Arquillian Chameleon shall download (if not exists) a servlet container specified in @ChameleonTarget and start them, then a deploy of the application specified in @Deployment will be done, after that the junit Junit4 will be executed. Ex...

@RunWith(ArquillianChameleon.class)
@ChameleonTarget(value="wildfly:11.0.0.Final:managed")
public class ClientResourceIT {

    @Deployment
    public static WebArchive deploy() {

        // Get all dependencies in pom.xml
        File[] archives = Maven.resolver().loadPomFromFile("pom.xml")
                .importDependencies(ScopeType.COMPILE, ScopeType.TEST, ScopeType.PROVIDED, ScopeType.RUNTIME)
                .resolve()
                .withTransitivity()
                .asFile();

        // Make a war file
        WebArchive war = ShrinkWrap
                        .create(WebArchive.class, "restful-api.war")
                        .addPackages(true, "br.com.app.restful")
                        .addAsResource("META-INF/persistence.xml")
                        .addAsLibraries(archives)
                        .addAsWebInfResource("jboss-web.xml")
                        .addAsWebInfResource(new StringAsset("<beans bean-discovery-mode=\"all\" version=\"1.1\"/>"), "beans.xml");

        return war;
    }
    // RestAssured Tests
    ...
}

ApiDocs

To document the api Swagger was used, a powerful api that follow the OpenAPI specification. After deploy the project you can see the docs in:

Swagger JSON

http://localhost:8080/restful-api/v1/openapi/openapi.json

Swagger UI

http://localhost:8080/restful-api/v1/openapi/apidocs/index.html

filipesoares/jee-sample-restful-api