Skip to content

⚠️ (The project doesn't finish) This is REST API service for regions application.

Notifications You must be signed in to change notification settings

vaskocuturilo/Regions-Service

Repository files navigation

Spring Boot Service for Region Application.

SWUbanner

The Spring Boot REST service for region application.

Requirements:

  • Use any object-oriented language.
  • Use the last Spring boot version.
  • Use the last MySQL database version.
  • Create REST API service.
  • Create docker-compose for run service.
  • Provide code and clear instructions on how to run it.

Note: Please put your code in a public repository.

Note: Please send a link to this repo when you are done.

You will need the following technologies available to try it out:

  • Git
  • Spring Boot
  • Mysql
  • Gradle 3+
  • JDK 8
  • Docker
  • IDE of your choice

TO-DO list (ASAP):

  • Will be adding functionality for search by region code. ✔️
  • Will be adding functionality for search by region name, city, and district. ✔️
  • Will be adding functionality for parsing a car plate from an image.
  • Migrate Database for MySQL -> PostgreSQL.
  • Will be adding validation fields. ✔️
  • Will be adding V2 (one controller, one service, one repository for all countries)
  • Will be adding UI (Countries field) ✔️
  • Will be adding JWT. ✔️
  • Will be adding X-API-KEY. ✔️
  • Will be adding a one-time password. ✔️
  • Will be adding docker-compose ✔️
  • Will be adding integration tests for each country. ✔️
  • Will be adding unit tests. ✔️
  • Will be fixing Germany country.
  • Will be adding old registration car plates for Poland
  • Will be adding old registration car plates for Britain.
  • Will be fixing British country. ✔️
  • Will be adding functionality for deployment to AWS. ✔️
  • Will be adding React or Angular frameworks. ✔️
  • Will be adding functionality for search diplomatic plates. ✔️
  • Will be adding UI (diplomatic field) ✔️
  • Will be adding positive UI automation scripts (Smoke and Sanity) ✔️
  • Will be adding negative UI automation scripts (Smoke and Sanity) ✔️
  • Will be adding migration from Spring boot v2.5.3 to v3.1.*
  • Will be adding Logging. ✔️
  • Will be adding user controller ✔️
  • Will be adding Jest unit testing for node JS
  • Fix the UI interface ✔️
  • will be adding the Google map.
  • Will be adding logout timeout functionality. ✔️
  • Will be adding a UI form for the generation of an apiKey.

Actuator

{
"status": "UP"
}

Swagger-UI

How it works. (Not correct schema)

How to run.

docker-compose -f "docker-compose.yml" up --detach --build

API endpoints

These endpoints allow you to handle Stripe subscriptions for Publish and Analyze.

GET

official client only http://localhost:8080/api/v1/poland/plates/region/wx

{
   "description": "Województwo mazowieckie, Warszawa-Żoliborz",
    "region": "WX"
}

GET

official client only http://localhost:8080/api/v1/poland/plates/description/Warszawa-Żoliborz

{
   "description": "Województwo mazowieckie, Warszawa-Żoliborz",
      "region": "WX"
}

The Web site link is

link

How it looks

About

⚠️ (The project doesn't finish) This is REST API service for regions application.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published