auth-api
auth-api copied to clipboard
This repository contains a simple Java Spring project that implements authentication and authorization using Spring Security
Authentication API
This project is an API built using Java, Java Spring, Flyway Migrations, PostgresSQL as the database, and Spring Security and JWT for authentication control.
The API was developed for my Youtube Tutorial, to demonstrate how to configure Authenticatio and Authorization in Spring application using Spring Security.
Table of Contents
- Installation
- Configuration
- Usage
- API Endpoints
- Authentication
- Database
- Contributing
Installation
- Clone the repository:
git clone https://github.com/Fernanda-Kipper/auth-api.git
-
Install dependencies with Maven
-
Install PostgresSQL
Usage
- Start the application with Maven
- The API will be accessible at http://localhost:8080
API Endpoints
The API provides the following endpoints:
GET /product - Retrieve a list of all products. (all authenticated users)
POST /product - Register a new product (ADMIN access required).
POST /auth/login - Login into the App
POST /auth/register - Register a new user into the App
Authentication
The API uses Spring Security for authentication control. The following roles are available:
USER -> Standard user role for logged-in users.
ADMIN -> Admin role for managing partners (registering new partners).
To access protected endpoints as an ADMIN user, provide the appropriate authentication credentials in the request header.
Database
The project utilizes PostgresSQL as the database. The necessary database migrations are managed using Flyway.
Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request to the repository.
When contributing to this project, please follow the existing code style, commit conventions, and submit your changes in a separate branch.