Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 2.72 KB

README.md

File metadata and controls

62 lines (51 loc) · 2.72 KB

Flood Disney API

API to explore the world of Disney, which allows knowing and modifying the characters that compose it and understand in which films they participated. Alkemy's Backend Challenge by Patricio Tomás Flood.

Full Api Docs: https://disney-api.flood.ar/api-docs

Endpoints

Base Url: https://disney-api.flood.ar/

Open endpoints

Auth

  • POST /register -> Register a new User
  • POST /login -> Login with Email and Password

Endpoints that require Authentication

Characters

  • GET /characters -> Get all Characters or Filter Characters
  • POST /characters -> Create a new Character
  • GET /characters/{characterId} -> Get Character By ID
  • PUT /characters/{characterId} -> Update Character by ID
  • DELETE /characters/{characterId} -> Delete Character by ID
  • POST /characters/{characterId}/uploadImage -> Upload Image to Character by ID

Movies

  • GET /movies -> Get all Movies or Filter movies
  • POST /movies -> Create a new Movie
  • GET /movies/{characterId} -> Get Movie By ID
  • PUT /movies/{movieId} -> Update Movie by ID
  • DELETE /movies/{movieId} -> Delete Movie by ID
  • POST /movies/{movieId}/uploadImage -> Upload Image to Movie by ID
  • POST /movies/{movieId}/asociateCharacter -> Asociate Character to Movie by ID
  • DELETE /movies/{movieId}/asociateCharacter/{characterId} -> Desasociate Character to Movie by Movie ID and Character ID

Genres

  • GET /genres -> Get all Genres or Filter Genres
  • POST /genres -> Create a new Genre
  • GET /genres/{genreId} -> Get Genre By ID
  • PUT /genres/{genreId} -> Update Genre by ID
  • DELETE /genres/{genreId} -> Delete Genre by ID
  • POST /genres/{genreId}/uploadImage -> Upload Image to Genre by ID

Environment Variables (.env)

  • PORT (Server Port)
  • DATABASE_URL, TEST_DATABASE_URL (PostgreSQL DataBase URLs for production, and testing)
  • SECRET (Secret String - JsonWebToken)
  • SENDGRID_API_KEY, SENDGRID_EMAIL_FROM (Sendgrid Credentials - Email Service)
  • AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY (AWS S3 credentials - Upload Images)
  • TEST_USER_EMAIL, TEST_USER_PASSWORD (Test User registered in Test Database)