Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/monicaalyssa/movie-api

RESTful API built with Node.js and Mongoose for the PopcornPal application to handle movie and user data.
https://github.com/monicaalyssa/movie-api

express javascript mongodb nodejs

Last synced: about 9 hours ago
JSON representation

RESTful API built with Node.js and Mongoose for the PopcornPal application to handle movie and user data.

Awesome Lists containing this project

README

        

## Installation

To use this application locally, follow these steps inside your terminal:

1. Clone this repository to your local machine:
```bash
git clone https://github.com/monicaalyssa/movie-api
```
Woman Technologist

2. Navigate to the project directory: `cd movie-api`
3. Install dependencies: `npm install`
4. Start the development server: `npm start`
5. Open your browser and visit: `http://localhost:8082`

## API Endpoints

**Base URL**
```
https://popcornpal-32d285ffbdf8.herokuapp.com/
```

#### Existing movie data

GET /movies (gets a list of all movies)

##### Parameters

> | None |
> |---------------|

##### Responses

> | HTTP Code | Content-Type | Response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `201` | `application/json; charset=utf-8` | JSON array of objects

GET /movies/{uuid} (gets data about a specific movie by id)

##### Parameters

> | Name | Data Type | Description |
> |--------|----------------|------------------------------------------------------|
> | `uuid` | string | The specific movie id |

##### Responses

> | HTTP Code | Content-Type | Response |
> |---------------|-----------------------------------|---------------------------------------------------------------------|
> | `201` | `application/json; charset=utf-8` | JSON object
> | `500` | `text/html; charset=utf-8` | `"Error: " + message`