README.md 828 Bytes
Newer Older
Ivaylo Ivanov's avatar
Ivaylo Ivanov committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
## IBM CIC Coding Challenge - REST API

1. Prerequisites
    * Apache Tomcat
    * Maven

2. Used Libraries and Frameworks
    * Jersey  RESTful Web Services Framework (https://jersey.github.io/)
    * JSON in Java (https://github.com/stleary/JSON-java)
    * Apache Commons IO (https://commons.apache.org/proper/commons-io/)
    
3. Running the project 
    * Import the project in IntelliJ IDEA (preferred) or Eclipse
    * Download the dependencies with Maven
    * Start Apache Tomcat

4. Using the API
    * After starting Apache Tomcat point your browser of choice to
     ``http://localhost:8080/rest``
     * You can filter your request by adding the filter parameter as follows:
     ``http://localhost:8080/rest?filter=<title_or_location>``
     * Port ``8080`` is the default one, you can set anything you'd like here