Gives you the facility to add a shop with address. Stores the longitude and latitude of your shop using Google Geocoding API. You can request for a shop mentioning your current latitude and longitude. The API would return you the shop nearest to you.
To add a resource
Resource : /shop
Description : Adds a shop. The API would find out the latitude and longitude of the
shop address using Google Maps API and store it with the address.
Method : POST
Request Content-type: application/json
Example Request : {
"shopName": "Amphitheatre Parkway",
"shopAddress": {
"number": "1600",
"addressLine1" : "Mountain View",
"addressLine2" : "CA",
"postCode": "94043"
}
}
Success Response : 200 OK
To get a resource
Resource : /shop/{latitude}/{longitude}
Description : Gives you the nearest shop from your latitude and longitude.
Method : GET
Response Content-type : application/json;charset=UTF-8
Example Response : 200 OK
{
"shopName": "Amphitheatre Parkway",
"shopAddress": {
"number": "1600",
"addressLine1": "Mountain View",
"addressLine2": "CA",
"postCode": "94043"
},
"shopLatitude": 37.422364,
"shopLongitude": -122.084364
}
To get resources list
Resource : /shop
Description : Gives you the list of available shops
Method : GET
Response Content-type : application/json;charset=UTF-8
Example Response : 200 OK
[
{
"id": 352466615589618128,
"shopName": "Amphitheatre Parkway",
"shopAddress": {
"number": "1600",
"addressLine1": "Mountain View",
"addressLine2": "CA",
"postCode": "94043"
},
"shopLatitude": 37.4223434,
"shopLongitude": -122.0843689
},
{
"id": 2463921798603719949,
"shopName": "AMC Cupertino Square 16",
"shopAddress": {
"number": "10123 N Wolfe Rd #3000",
"addressLine1": "Cupertino",
"addressLine2": "CA",
"postCode": "95014"
},
"shopLatitude": 37.3302487,
"shopLongitude": -122.0142856
}
]
You need Java 8 for running this project.
Maven : If using maven you can use below command to run it
mvn spring-boot:run -Dserver.port=8082
Gradle : If using gradle use below command to run it
gradle bootRun
As jar : You can directly run it as a jar using below command. Change the path to the jar accordingly
java -jar -Dserver.port=8082 shops-near-you.jar
If you do not change the port using -Dserver.port=8082 by default the embedded Tomcat runs on port 8080
If you are running it behind a proxy server, set the proxy setting in application.properties. e.g.
config.proxy=true
config.proxyaddress=<your proxy host address>
config.proxyport=<your proxy port>
config.proxyuser=<user name>
config.proxypassword=<proxy password>
Else update the file as config.proxy=false.
The Google Maps Geocoding API is a service that provides you the latitude and longitude of an address which is called geocoding. It also supports reverse geocoding i.e. gives you the address from the latitude and longitude provided. To use this Geocoding API you need to first register your application with Google using your Google ID. After registration Google gives you an API key which you need to update in the application.properties file as
config.apikey=<your key goes here>
The Great-circle distance or orthodromic distance is the shortest distance between two points on the surface of a sphere, measured along the surface of the sphere (as opposed to a straight line through the sphere's interior). Haversine formula is used to calculate the Great-circle distance between two points on a sphere from their longitudes and latitudes. Refer this article for the formula.