Giter Club home page Giter Club logo

movies-characters-api's Introduction

Movies Characters API

What does this Rest API do? ๐Ÿš€

It allows to manage entities, persist them and obtain a robust security with Spring Security and JWT

Main features:

  1. Security

    1.1 Secure user authentication using Spring Security.

    1.2 Generation and validation of JWT tokens to guarantee authorization.

    1.3 Establishment of roles and privileges for users (USER, ADMIN and MANAGER).

    1.4 Restriction of access to resources according to the roles and privileges assigned.

    1.5 Sending a welcome email to the user upon registration.


  2. Entities: Users can create and manage three main entities: Character, Movie, and Genre.

  3. Persistence: Entity data is stored in an SQL database for persistence.

  4. Relationships: Users have the ability to relate existing or created entities. For example, characters can be linked to movies, and the latter to genres.

  5. CRUD Operations: The API provides basic create, read, update, and delete (CRUD) operations for parent entities.

  6. Advanced Filtering: In addition to CRUD operations, the API allows users to filter desired information from the database, providing additional functionality to meet their specific needs.

Technologies ๐Ÿ› ๏ธ

  • Java 17
  • Spring Boot 3.0.4
  • JSON Web Tokens
  • Project Lombok
  • MySQL
  • SendGrid - Sending Emails
  • OpenAPI 2.1 - Document The API
  • Postman - Document The API

Installation and Execution ๐Ÿ”ง

  1. Clone this repository :
    https://github.com/majuarezmagarinios/moviesCharactersAPI.git

  2. Create Schema with name "moviescharactersapi"

  3. Change username and password in application.properties

  4. When you register or log in correctly you will get a token with which you can access the endpoints according to your role and permissions

  5. In the src\apiDocumentation folder there is a file that you can export to Postman where you will have all the http methods to test

  6. You must create the application key of your email provider. For example for Gmail you can follow this link Link.

  7. In the resources/application.properties file, place the key generated in the previous point after the equals sign, in the property "spring.sendgrid.api-key=" (line 36). Save changes.

  8. Go to services/SendGrid mail Service and on line 22 replace "[email protected]" with your mail. Save changes.

  9. You have finished the minimum configuration so that emails are sent to the user when they register.

movies-characters-api's People

Contributors

majuarezmagarinios avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.