Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 2.2 KB

README.md

File metadata and controls

69 lines (41 loc) · 2.2 KB

Authentication API

Java Spring JWT

This project is an API built using Java, Java Spring, MariaDB as the database, and Spring Security and JWT for authentication control.

This API was based on Fernanda Kipper's project, as explained in this YouTube link Youtube Tutorial, to demonstrate how to configure Authenticatio and Authorization in Spring application using Spring Security.

Table of Contents

Installation

  1. Clone the repository:
git clone https://github.com/Fernanda-Kipper/auth-api.git
  1. Install dependencies with Maven

Usage

  1. Start the application with Maven
  2. 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.

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.