Skip to content

Latest commit

 

History

History
231 lines (152 loc) · 6.92 KB

README.md

File metadata and controls

231 lines (152 loc) · 6.92 KB
Raw

Mrtechspecs REST API

This project contains the api for Mrtechspecs website, where users can find the latest specifications about the latest phones.

Table of Contents

  1. Tools
  2. Dependencies
  3. Getting Started
  4. Database
  5. REST Endpoints

Tools

You will need:

  • Maven as your build tool
  • Your favorite IDE
  • JDK 1.8+
  • MySQL

Dependencies

You will need:

Getting Started

First, clone the project:

$ git clone https://github.com/ealili/springboot-rest-api.git

Second, configure the database.

Database

  1. Create a MySQL database using the mrtech.sql script provided in the root folder.
  2. Add credentials to /src/main/resources/application.properties.

The default ones are:

spring.datasource.url=jdbc:mysql://localhost:3306/mrtech
spring.datasource.username=root
spring.datasource.password=
spring.jpa.database-platform = org.hibernate.dialect.MySQL5Dialect
spring.jpa.generate-ddl=true
spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
spring.jpa.hibernate.ddl-auto = update

Finally, open the project using your favorite IDE and install all the listed dependencies above and you should be able to run the project.

If everything works, you should see an Index Page here.

REST Endpoints

Index Endpoint

Index Page, later this endpoint will provide all the available routes.

  • URL http://localhost:8080/, METHOD = GET.

Administrator Endpoints

Get an administrator by username and password

  • URL http://localhost:8080/api/administrator, METHOD = POST, expects JSON body.

e.g. Getting an administrator at (http://localhost:8080/api/administrator) using the JSON objet below:

{
  "username": "selaudin",
  "password": "selaudin123"
}

At this point there is no authentication provided for the administrator.

Save an administrator

  • URL http://localhost:8080/api/administrator/save, METHOD = POST, expects JSON body.

e.g. Saving an administrator at (http://localhost:8080/api/administrator/save) using the JSON object below:

{
  "username": "agni",
  "name": "Agni Ramadani",
  "password": "agni123"
}

Update an administrator by username

  • URL http://localhost:8080/api/administrator/update/{username}, METHOD = POST, expects a path variable username and a JSON body.

e.g. Updating an administrator at (http://localhost:8080/api/administrator/update/selaudin) using the JSON object below:

{
  "username": "sela",
  "name": "Selaudin",
  "password": "sela123"

With this object the username which is a primary key in the administrator table will also get updated.

Delete an administrator by username

  • URL http://localhost:8080/api/administrator/delete/{username}, METHOD = GET, expects a path variable username.

e.g. Deleting an administrator with the username selaudin at (http://localhost:8080/api/administrator/delete/selaudin)

Phone Endpoints

Get all phones

  • URL http://localhost:8080/api/phones, METHOD = GET.

Get phones by manufacturer name

  • URL http://localhost:8080/api/phones/{mname}, METHOD = GET, expects a path variable mname.

e.g. Getting phones of the manufacturer called Samsung at (http://localhost:8080/api/phones/Samsung)

Get a phone by id

  • URL http://localhost:8080/api/phone/{id}, METHOD = GET, expects a path variable id.

e.g. Getting a phone with the id samsungGalaxyNote10 at (http://localhost:8080/api/phone/samsungGalaxyNote10)

Save a phone

  • URL http://localhost:8080/api/phone/save, METHOD = POST, expects a JSON body.

eg Saving a phone at (http://localhost:8080/api/phone/save) using the JSON body below:

{
	"displayType": "Super AMOLED capacitive touchscreen, 16M colors",
	"displayResolution": "1080 x 2400 pixels",
	"displaySize": "6.5 inches",
	"selfieCamera": "32 MP, f/2.2",
	"mainCamera": "48 MP, f/2.0, 12 MP, f/2.2, 5 MP, f/2.4, 5 MP, f/2.2",
	"mname": "Samsung",
	"name": "Samsung Galaxy A51",
	"productionYear": "2019",
	"technology": "GSM / HSPA / LTE",
	"weight": "172 g (6.07 oz)",
	"sound": "Single Speaker",
	"os": "Android 9 (One UI)",
	"battery": "Non-removable Li-ion 4000 mAh battery",
	"imgSource": "https://fdn2.gsmarena.com/vv/pics/samsung/samsung-galaxy-a51-sm-a515-1.jpg"
}

Update a phone by id

  • URL http://localhost:8080/api/phone/update/{id}, METHOD = POST, expects a path variable id and a JSON body.

e.g. Updating a phone at (http://localhost:8080/api/phone/update/samsungGalaxyA9) using

{
	"displayType": "Super AMOLED capacitive touchscreen, 16M colors",
	"displayResolution": "1080 x 2400 pixels",
	"displaySize": "6.5 inches",
	"selfieCamera": "32 MP, f/2.2",
	"mainCamera": "48 MP, f/2.0, 12 MP, f/2.2, 5 MP, f/2.4, 5 MP, f/2.2",
	"mname": "Samsung",
	"name": "Samsung Galaxy A10",
	"productionYear": "2019",
	"technology": "GSM / HSPA / LTE",
	"weight": "172 g (6.07 oz)",
	"sound": "Single Speaker",
	"os": "Android 9 (One UI)",
	"battery": "Non-removable Li-ion 4000 mAh battery",
	"imgSource": "https://fdn2.gsmarena.com/vv/pics/samsung/samsung-galaxy-a51-sm-a515-1.jpg"
}

As we see here the phone with the id samsungGalaxyA9 will be updated with the JSON body provided above. The id will change due to its name

Delete a phone by id

  • URL http://localhost:8080/api/phone/delete/{id}, METHOD = GET, expects a path variable id.

e.g. Deleting a phone with the id samsungGalaxyNote10 at (http://localhost:8080/api/phone/delete/samsungGalaxyNote10)

Manufacturer Endpoints

Get all manufactures

  • URL http://locahost:8080/api/manufacturers, METHOD = GET.

Save a manufacturer

  • URL http://localhost:8080/api/manufacturer/save, METHOD = POST, expects a JSON body.

e.g. Saving a manufacturer at (https://localhost:8080/api/manufacturer/save) using the JSON object below:

{
  "mname": "OnePlus,
  "headquarters": "China"
}

Delete a manufacturer by manufacturer name

  • URL http://localhost:8080/api/manufacturer/delete/{mname}, METHOD = GET, expects a path variable mname.

e.g. Deleting a manufacturer with the name Samsung (http://localhost:8080/api/manufacturer/delete/Samsung)