Clash Guide API

This RESTful API is built using Spring Boot with a clean MVC architecture that displays all the available Troops in Clash Of Clans along with their details.

Features

• MVC architecture.
• Uses MongoDB Atlas for Database.

Routes

Get all Troops

Parameter	Description
size (int)	(optional) by default the size is unlimited. Example: GET /get-all-troops?size=1
sort (int)	(optional) by default there is not sort. Example: GET /get-all-troops?size=1?sort=name

Output:

{
    "content": [
      {
        "_id": "6612bba0ced75d1ea06af6d2",
        "name" : "Super Barbarian",
        "description" : "Superior in health, power, speed and most importantly, hair, the Super Barbarians are what regular Barbarians dream of becoming!",
        "image" : "https://firebasestorage.googleapis.com/v0/b/clash-guide-app.appspot.com/o/Super%20Troops%2FSuper_Barbarian.png?alt=media&token=75f32d7e-12e1-48e8-b486-c97dc9288727",
        "color" : "0XFFDDEE19",
        "isSuperTroop" : true
      }
    ],
    {...},
    ...
}

Add a Troop

Parameter	Description
key (string)	This operation requires an Auth key. Example: POST /add-troop?key=AUTH_KEY
body	Add a Troop by providing a body. Example: POST /add-troop

Request Body:

{
  "name" : "Golem",
  "description" : "The mighty Golem loves to soak up damage! When destroyed, it explodes and splits into Golemites. The resulting Golemites have one-fifth the Golem's strength and hitpoints.",
  "image" : "https://firebasestorage.googleapis.com/v0/b/clash-guide-app.appspot.com/o/Troops%2FGolem.png?alt=media&token=6cdf4c29-6940-4efa-93a1-d1fcd058bac5",
  "color" : "0XFF606D68",
  "isSuperTroop" : false
}

Output:

  Troop added successfully!

Update a Troop

Parameter	Description
_id (string)	Update a Troop by providing it's _id. Example: PATCH /update-troop/6612bba0ced75d1ea06af6d2
key (string)	This operation requires an Auth key. Example: PATCH /update-troop/6612bba0ced75d1ea06af6d2?key=AUTH_KEY
body	Provide a body.

Request Body:

{
  "name" : "Super Valkyrie",
  "description" : "Not only are Super Valkyries superior to regular Valkyries in every way, they're also way more angry!",
  "image" : "https://firebasestorage.googleapis.com/v0/b/clash-guide-app.appspot.com/o/Super%20Troops%2FSuper_Valkyrie.png?alt=media&token=2834d3b1-ae82-4ffb-a09e-6652bf833be1",
  "color" : "0XFFF75B2A",
  "isSuperTroop" : true
}

Output:

  Troop updated successfully!

Delete a Troop

Parameter	Description
_id (string)	Delete a Troop by providing it's _id. Example: DELETE /delete-troop/6612bba0ced75d1ea06af6d2
key (string)	This operation requires an Auth key. Example: DELETE /delete-troop/6612bba0ced75d1ea06af6d2?key=AUTH_KEY

Output:

  Troop removed successfully!

Delete all Troops

Parameter	Description
key (string)	This operation requires an Auth key. Example: DELETE /delete-all-troops?key=AUTH_KEY

Output:

  All troops removed successfully!

Run locally

• Create a env.properties file in resources directory:

  KEY = AUTH_KEY
  USER_NAME = your username
  PASSWORD = your password
  CLUSTER = your cluster
  DEV_DB = test DB name
  PROD_DB = Production DB name
  

• Change the connection string to yours in application.properties

• Run command:

  ./gradlew bootRun
  

• Navigate to:

  localhost:8080/
  

Create your own Instance on Render

• Fork this repository.

• Change the connection string to yours in application.properties

• Provide the Environment variables in the setup process on Render or any other platform:

  KEY = AUTH_KEY
  USER_NAME = your username
  PASSWORD = your password
  CLUSTER = your cluster
  DEV_DB = test DB name
  PROD_DB = Production DB name
  

• Deploy your app.