https://github.com/vbrazhnik/movie-library-api
Movie Library RESTful API [MongoDB + Express.js + Node.js]
https://github.com/vbrazhnik/movie-library-api
express-js mongodb movies-api moviesdb-api node-js restful-api
Last synced: 3 months ago
JSON representation
Movie Library RESTful API [MongoDB + Express.js + Node.js]
- Host: GitHub
- URL: https://github.com/vbrazhnik/movie-library-api
- Owner: VBrazhnik
- Created: 2019-01-28T23:03:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-16T08:43:45.000Z (about 5 years ago)
- Last Synced: 2025-01-11T21:13:43.829Z (4 months ago)
- Topics: express-js, mongodb, movies-api, moviesdb-api, node-js, restful-api
- Language: JavaScript
- Homepage:
- Size: 64.5 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Movie Library RESTful API
The server supports basic CRUD operations.
Movie Library RESTful API was developed using MongoDB, Express.js and Node.js.
## Installation
Clone repository and install node modules:
```
$ git clone
$ cd
$ npm install
```
Modify `.env` file for your environment and then run the following command:
```
$ npm run start
```
Also, you can initiate your database with a few records using the following command:
```
$ npm run import
```
But don't forget to modify it for your environment before execution.
This command will import data from `movie-library-sample.json` to your MongoDB.
## Movie
### Structure
| Field | Data Type | Required | Restrictions |
| :---------- | :--------------- | :----------- | :------------------------------------------- |
| `title` | String | Required | No longer than 100 characters |
| `year` | Number | Required | No less than 1800 and no more than 3000 |
| `directors` | Array of strings | Not required | Each string is no longer than 100 characters |
| `writers` | Array of strings | Not required | Each string is no longer than 100 characters |
| `cast` | Array of strings | Not required | Each string is no longer than 100 characters |
### Schema
```js
const movieSchema = new mongoose.Schema({
title: {
type: String,
maxlength: 100,
required: true,
},
year: {
type: Number,
min: 1800,
max: 3000,
required: true,
},
directors: [
{
type: String,
maxlength: 100,
},
],
writers: [
{
type: String,
maxlength: 100,
},
],
cast: [
{
type: String,
maxlength: 100,
},
],
});
```
### Example
```json
{
"title": "The Girl with Dragon Tattoo",
"year": 2011,
"directors": ["David Fincher"],
"writers": ["Steven Zaillian", "Stieg Larsson"],
"cast": ["Daniel Craig", "Rooney Mara", "Christopher Plummer"]
}
```
## RESTful API
| URL | HTTP Method | Body of Request | Response |
| :---------------- | :---------- | :-------------- | :---------------------- |
| `/api/movies` | `GET` | — | All movies |
| `/api/movies` | `POST` | JSON | Created movie |
| `/api/movies/:id` | `GET` | — | Movie with the given ID |
| `/api/movies/:id` | `PUT` | JSON | Updated movie |
| `/api/movies/:id` | `DELETE` | — | Deleted movie |