This repository contains the source code for a REST API for movies. The API allows users to search for and find information about movies, including search by title, director, actor, and category, and the ability to display descriptions and information about movies from a movie database. The API was built using Python, Flask, and SQLAlchemy, and is accessible via HTTP requests and responses.
- Search for movies by title, director, actor, or category
- View detailed information about movies, including descriptions, cast and crew, and release date
- Secure authentication and authorization using JSON Web Tokens (JWT)
- Robust security measures to protect sensitive data
- Scalable and performant design, able to handle high volume of requests and responses
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Python 3.6 or higher
- Flask
- Flask-SQLAlchemy
- Flask-JWT-Extended
The Movie REST API uses Mailgun API to send registration email to new users.
- Clone the repository:
git clone https://github.com/GhaziBoussida/MOVIE-REST-API.git- Install the required dependencies:
pip install -r requirements.txt- Set the FLASK_APP and FLASK_ENV environment variables:
export FLASK_APP=app
export FLASK_ENV=development- Set the MAILGUN_API_KEY and MAILGUN_DOMAIN environment variables in .env file:
MAILGUN_API_KEY="Value"
MAILGUN_DOMAIN="Value"
- Run the development server:
flask runAdd new user to the database.
- 'Authorization': JWT token
- username (required) : Username of the user.
- password (required) : password of the user.
- 201, Success
{
"message": "User created successfully."
}- 400 , Error
{
"message":"A user with that username already exists."
}Login as a registered user and obtain access and refresh tokens.
- username (required) : Username of the user.
- password (required) : password of the user.
- 200, Succes
{
"access_token": "string",
"refresh_token": "string"
}- 401 , Error
{
"message":"Invalid credentials."
}Logout of logged user.
- 'Authorization': Bearer access token.
- No parameters
- 200, Success
{
"message": "Successfully logged out"
}Get a specific user by his ID.
- user_id (required) : ID of the user to fetch.
- 200, Success
{
"id": integer,
"username": "string"
}- 404, Error
{
"message": "User not found"
}Detele specific user by his ID
- 'Authorization': Bearer access token.
- user_id (required) : ID of the user to delete.
- 200, Success
{
"message": "User deleted."
}- 404, Error
{
"message": "User not found"
}Obtain a fresh access token.
- 'Authorization': Bearer refresh token.
- No parameters
- 200, Success
{
"access_token": "string"
}Add actor to the database.
- 'Authorization': Bearer access token.
- name (required): Name of the actor to create.
- 200, Success
{
"id": integer,
"movies": [],
"name": "string"
}- 400, Error
{
"message": "An actor with name {name} already exists."
}- 500, SQLAlchemyError
{
"message": "An error occurred while inserting the actor."
}Get specific actor by name.
- 'Authorization': Bearer access token.
- name (required): Name of the actor to fetch.
- 200, Success
{
"id": integer,
"movies": [],
"name": "string"
}- 404, Error
{
"message": "Actor not found."
}Delete specific actor by name.
- 'Authorization': Bearer access token
- name (required): Name of the actor to delete.
- 200, Success
{
"message": "Actor deleted."
}- 404, Error
{
"message": "Actor not found."
}Get list of all actors in the database.
- 'Authorization': Bearer access token
- No parameters
- 200, Success
[
{
"id": integer,
"name": "string",
"movies": [
{
"id": integer,
"release_date": "string",
"description": "string",
"name": "string"
}
]
}
]Link existing specific actor by ID to existing specific movie by ID.
- 'Authorization': Bearer access token
- movie_id (required) : ID of the movie to link.
- actor_id (required) : ID of the actor to link.
- 200, Success
{
"id": integer,
"name": "string",
"movies": [
{
"id": integer,
"release_date": "string",
"description": "string",
"name": "string"
}
]
}- 404, Error
{
"status": "Not Found"
}- 500 , SQLAlchemyError
{
"message":"An error occurred while inserting the actor."
}- 'Authorization': Bearer access token
- movie_id (required) : ID of the movie to unlink.
- actor_id (required) : ID of the actor to unlink.
- 200, Success
{
"message": "Actor removed from Movie"
}- 404, Error
{
"message": "Actor not found in movie.",
}- 401, Error
{
"message":"Admin privilege required."
}- 500, SQLAlchemyError
{
"message": "An error occurred while inserting the actor."
}Add director to the database.
- 'Authorization': Bearer access token.
- name (required): Name of the director to create.
- 200, Success
{
"id": integer,
"movies": [],
"name": "string"
}- 400, Error
{
"message": "A director with name {name} already exists."
}- 500, SQLAlchemyError
{
"message": "An error occurred while inserting the director."
}Get specific director by name.
- 'Authorization': Bearer access token.
- name (required): Name of the director to fetch.
- 200, Success
{
"id": integer,
"movies": [],
"name": "string"
}- 404, Error
{
"message": "Director not found."
}Delete specific director by name.
- 'Authorization': Bearer access token
- name (required): Name of the director to delete.
- 200, Success
{
"message": "Director deleted."
}- 404, Error
{
"message": "Director not found."
}- 401, Error
{
"message":"Admin privilege required."
}Get list of all directors in the database.
- 'Authorization': Bearer access token
- No parameters
- 200, Success
[
{
"id": integer,
"name": "string",
"movies": [
{
"id": integer,
"release_date": "string",
"description": "string",
"name": "string"
}
]
}
]Add category to the database.
- 'Authorization': Bearer access token.
- name (required): Name of the category to create.
- 200, Success
{
"id": integer,
"movies": [],
"name": "string"
}- 400, Error
{
"message": "A category with name {name} already exists."
}- 500, SQLAlchemyError
{
"message": "An error occurred while inserting the category."
}Get specific category by name.
- 'Authorization': Bearer access token.
- name (required): Name of the category to fetch.
- 200, Success
{
"id": integer,
"movies": [],
"name": "string"
}- 404, Error
{
"message": "Category not found."
}Delete specific category by name.
- 'Authorization': Bearer access token
- name (required): Name of the category to delete.
- 200, Success
{
"message": "Category deleted."
}- 404, Error
{
"message": "Category not found."
}- 401, Error
{
"message":"Admin privilege required."
}Get list of all categories in the database.
- 'Authorization': Bearer access token
- No parameters
- 200, Success
[
{
"id": integer,
"name": "string",
"movies": [
{
"id": integer,
"release_date": "string",
"description": "string",
"name": "string"
}
]
}
]Add movie to the database.
- name (required): Name of the movie to create.
- category_id : ID of the category of the movie to create.
- director_id : ID of the director of the movie to create.
- description : Description of the movie to create.
- release_date : Release date of the movie to create.
- 200, Success
{
"category": {
"id": integer,
"name": "string",
"movies": [
{
"release_date": "string",
"description": "string",
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]
},
"release_date": "string",
"description": "string",
"director": {
"id": integer,
"name": "string",
"movies": [
{
"release_date": "string",
"description": "string",
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]
},
"director_id": integer,
"category_id": integer,
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}- 400, Error
{
"message": "A movie with name {name} already exists."
}- 500, SQLAlchemyError
{
"message": "An error occurred while inserting the movie."
}Get specific movie by name.
- name (required): Name of the movie to fetch.
- 200, Success
{
"category": {
"id": integer,
"name": "string",
"movies": [
{
"release_date": "string",
"description": "string",
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]
},
"release_date": "string",
"description": "string",
"director": {
"id": integer,
"name": "string",
"movies": [
{
"release_date": "string",
"description": "string",
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]
},
"director_id": integer,
"category_id": integer,
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}- 404, Error
{
"message": "Movie not found."
}Delete specific movie by name.
- 'Authorization': Bearer access token
- name (required): Name of the movie to delete.
- 200, Success
{
"message": "Movie deleted."
}- 404, Error
{
"message": "Movie not found."
}- 401, Error
{
"message":"Admin privilege required."
}Get list of all movies in the database.
- No parameters
- 200, Success
[
{
"category": {
"id": integer,
"name": "string",
"movies": [
{
"release_date": "string",
"description": "string",
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]
},
"release_date": "string",
"description": "string",
"director": {
"id": integer,
"name": "string",
"movies": [
{
"release_date": "string",
"description": "string",
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]
},
"director_id": integer,
"category_id": integer,
"id": integer,
"actors": [
{
"id": integer,
"name": "string"
}
],
"name": "string"
}
]To run the API locally, follow these steps:
1- Clone the repository:
git clone https://github.com/GhaziBoussida/MOVIE-REST-API.git2- Install the dependencies:
pip install -r requirements.txt3- Run the database migrations:
flask db upgrade4- Start the API:
flask runThe API will be available at http://localhost:5000.
1- Push Repository to GitHub. Do NOT include the .env file that contains the API key.
2- Create Render.com account.
3- Link Github and Render accounts.
4- Create new WebService Project in Render
5- Link Github repository.
4- Add environment variables or upload .env file to Render.
5- Deploy the API
The API will be available at the domain URL provided by Render.
- Python - The programming language used
- Flask - The web framework used
- Flask-SQLAlchemy - The ORM used for interacting with the database
- Flask-JWT-Extended - A library for adding JSON Web Token (JWT) support to Flask, including access and refresh tokens, token refreshment, and role-based access control. This library was used to provide secure authentication and authorization for the API.
- MAILGUN API - Email API for Sending. Send, receive, and track emails with Mailgun's email API.