An open API service indexing awesome lists of open source software.

https://github.com/marceloxhenrique/parking-control-api

REST API for managing parking spot availability and access control systems, built with Java, Spring Boot, Spring Security for secure access, JUnit5 for unit testing, and Swagger for API documentation.
https://github.com/marceloxhenrique/parking-control-api

java junit5 spring-boot spring-security swagger

Last synced: about 2 months ago
JSON representation

REST API for managing parking spot availability and access control systems, built with Java, Spring Boot, Spring Security for secure access, JUnit5 for unit testing, and Swagger for API documentation.

Awesome Lists containing this project

README

          

# Parking Control API

This project provides a REST API for managing parking spot availability and access control systems. It is built using the following technologies:

* Java: As the primary programming language.
* Spring Boot: For rapid application development and simplified configuration.
* Spring Security: For user authentication and authorization.
* JUnit5: To test API endpoints.
* Swagger: To generate interactive API documentation.

## Prerequisites
* Java 17.0.10
* Maven

## Getting Started

First, clone the repository:

```shell
git clone https://git@github.com:marceloxhenrique/parking-control-api.git
```

## Navigate to the project directory

```shell
cd
```

## Install the project
```shell
mvn install
```

## Setup application.properties
```shell
spring.application.name=parking-control
spring.datasource.platform=postgres
spring.datasource.url=jdbc:postgresql://localhost:5432/postgres
spring.datasource.username=yourUsername
spring.datasource.password=yourPassword
spring.jpa.hibernate.ddl-auto=update

spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
```

## Running teh application
```shell
mvn spring-boot:run
```
- The app run on port 8080 by default.

## API documentation
```shell
http://localhost:8080/swagger-ui/index.html
```
![Capture d’écran 2024-05-23 à 15 02 18](https://github.com/marceloxhenrique/parking-control-api/assets/91223682/e6c596b9-4370-41a8-87b5-b52524a5b027)