Examples Showing How to Implement REST API using Spring Boot

This repository contains examples of how to use the Spring REST framework to implement an API which does some simple things:

1. Say hello
2. Tell the time of day
3. Compute prime numbers and prime factors of a number
4. Compute the Greatest Common Divisor (GCD) of two numbers
5. Compute the Least Commonn Multiple (LCM) of two numbers
6. Compute all Armstrong numbers in a given range (Note: Armstrong number (also known as Narcissistic numbers): An n-digit number equal to the sum of the nth powers of its digits.) Reference see http://mathworld.wolfram.com/NarcissisticNumber.html
7. Compute all palindromic numbers in a given range (Note: A palindromic number is a number (in some base ) that is the same when written forwards or backwards.) Reference see http://mathworld.wolfram.com/PalindromicNumber.html
8. Compute all amicable numbers in a given range (Note: Amicable numbers are two different numbers so related that the sum of the proper divisors of each is equal to the other number. (A proper divisor of a number is a positive factor of that number other than the number itself.) Reference see http://mathworld.wolfram.com/AmicablePair.html
9. Compute all perfect numbers in a given range (Note: Perfect number, a positive integer that is equal to the sum of its proper divisors. The smallest perfect number is 6, which is the sum of 1, 2, and 3.) Reference see http://mathworld.wolfram.com/PerfectNumber.html

NOTE: If you try to hit an invalid endpoint, the Spring controller advice will produce a nice error message indicating the endpoint is not in service.

Prerequisites needed to compile, test and execute the code

• java 1.8
• maven 3.3 or higher
• git

To execute the code

1. git clone https://github.com/jesimone57/spring_boot_rest_examples.git
2. mvn clean compile test
3. mvn spring-boot:run
4. For best results, use Google Chrome and install the JSONView chrome plugin to nicely format JSON results. Firefox browser also does an excellent job of formatting the JSON results.
5. Try any of the URLs below (Note: Spring Boot runs Tomcat server on localhost port 8080).

Swagger API Documentation

http://localhost:8080/swagger-ui.html

Hello Examples

Hello using a name as a path variable

http://localhost:8080/hello/tom

Hello using a name as a request paramter

http://localhost:8080/hello2?name=fred

Time of the Day Examples

Time of the day - plain text

http://localhost:8080/timeoftheday

Time of the day - in XML

http://localhost:8080/timeofthedayxml

Time of the day - in JSON

http://localhost:8080/timeofthedayjson

Primes, Factors, Greatest Command Divisor (GCD) and Least Common Multiple (LCM) Examples

Is the given number prime?

http://localhost:8080/isprime/101

http://localhost:8080/isprime/100

Find prime numbers in the given range

http://localhost:8080/primes?start=3&end=101

http://localhost:8080/primes?start=10001&end=10099

Find the prime factorization of the numbers in the given range

http://localhost:8080/primefactors?start=3&end=101

http://localhost:8080/primefactors?start=10001&end=10099

Find the prime factors of a given number

http://localhost:8080/primefactors/100

http://localhost:8080/primefactors/1024

Find the greatest common divisor (GCD) - also known as Greatest Common Factor (GCF)

http://localhost:8080/gcd/30/45

Find the least common multiple (LCM)

hhttp://localhost:8080/lcm/10/15

Armstrong/Narcissistic Numbers, Palindromic, Amicable and Perfect Number Examples

Find all the armstrong numbers in the given range

http://localhost:8080/armstrongs?start=1&end=10000

http://localhost:8080/armstrongs?start=1&end=100000

Find all the palindromic numbers in the given range

http://localhost:8080/palindromes?start=0&end=100

http://localhost:8080/palindromes?start=100&end=1000

same as above with error checking on the range. Note: Error response if url parameters are missing or wrong.

http://localhost:8080/palindromes

http://localhost:8080/palindromes?start=-1&end=1000

http://localhost:8080/palindromes?start=100&end=q

http://localhost:8080/palindromes?start=10&end=1

Find all the amicable numbers in the given range

http://localhost:8080/amicables?start=200&end=300

http://localhost:8080/amicables?start=1&end=100000

Find all the perfect numbers in the given range

http://localhost:8080/perfects?start=1&end=100

http://localhost:8080/perfects?start=5000&end=10000