Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/devpaulorcc/restful-api-films

🎬 API for movies made in Nest.js
https://github.com/devpaulorcc/restful-api-films

nestjs restful-api typescript

Last synced: 5 days ago
JSON representation

🎬 API for movies made in Nest.js

Host: GitHub
URL: https://github.com/devpaulorcc/restful-api-films
Owner: devpaulorcc
Created: 2024-12-08T21:03:03.000Z (2 months ago)
Default Branch: main
Last Pushed: 2025-01-18T17:21:58.000Z (23 days ago)
Last Synced: 2025-01-18T18:24:54.995Z (23 days ago)
Topics: nestjs, restful-api, typescript
Language: TypeScript
Homepage: https://rest-api-films.onrender.com
Size: 203 KB
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

## Description

This API allows you to manage a list of movies, offering operations to create, read, update, and delete movies in a database.

## Project setup

```bash
$ npm install
```

## Compile and run the project

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

## Base URL

```bash
https://rest-api-films.onrender.com
```

## Endpoints

### 1. `GET /`

**Description**: Checks the API status.
**Expected response**:

```bash
{
"code": 200,
"status": "OK",
"description": "An api made for all the functions of a CRUD for films."
}
```

### 2. `GET /films`

**Description**: List all movies.

**Expected response**:

```bash
[
{
"id": 1,
"title": "O Retorno de Jedi",
"director": "Richard Marquand",
"releaseDate": "1983-10-06T00:00:00.000Z",
"genre": "Ficção científica/Fantasia",
"createdAt": "2024-12-09T02:11:26.909Z"
},
{
"id": 2,
"title": "Blade Runner",
"director": "Ridley Scott",
"releaseDate": "1982-06-25T00:00:00.000Z",
"genre": "Ficção científica/Neo-noir",
"createdAt": "2024-12-09T02:12:01.693Z"
},
{
"id": 5,
"title": "Um Sonho de Liberdade",
"director": "Frank Darabont",
"releaseDate": "1994-09-22T00:00:00.000Z",
"genre": "Drama",
"createdAt": "2024-12-09T02:40:39.272Z"
},
{
"id": 6,
"title": "A Origem",
"director": "Christopher Nolan",
"releaseDate": "2010-07-16T00:00:00.000Z",
"genre": "Ficção Científica",
"createdAt": "2024-12-09T02:41:39.634Z"
}
...
]
```

### 3. `GET /films/{id}`

**Description**: Find one movie by id.

**Expected response**:

```bash

{
"id": 1,
"title": "O Retorno de Jedi",
"director": "Richard Marquand",
"releaseDate": "1983-10-06T00:00:00.000Z",
"genre": "Ficção científica/Fantasia",
"createdAt": "2024-12-09T02:11:26.909Z"
}

```

### 4. `POST /films`

**Description**: Adds a new movie to the catalog.

**Expected request format**:

```bash
{
"title": "Return of the Jedi",
"director": "Richard Marquand",
"releaseDate": "1983-10-06",
"genre": "Science Fiction/Fantasy"
}
```

**Expected response** (on success):

```bash
{
"id": 1,
"title": "Return of the Jedi",
"director": "Richard Marquand",
"releaseDate": "1983-10-06",
"genre": "Science Fiction/Fantasy",
"createdAt": "2024-12-14T12:00:00.000Z"
}
```

### 5. `PUT /films/{id}`

**Description**: Completely updates a movie by its ID.

**Expected request format**:

```bash
{
"title": "Star Wars: Episode III – Revenge of the Sith",
"director": "George Lucas",
"releaseDate": "2005-05-19",
"genre": "Science Fiction"
}
```

**Expected response**:

```bash
{
"id": 1,
"title": "Star Wars: Episode III – Revenge of the Sith",
"director": "George Lucas",
"releaseDate": "2005-05-19",
"genre": "Science Fiction",
"createdAt": "2024-12-14T12:00:00.000Z"
}
```

### 6. `PATCH /films/{id}`

**Description**: Partially updates a specific resource of a movie by its ID.

**Expected request format**:

```bash
{
"genre": "Fantasy"
}
```

**Expected response**:

```bash
{
"id": 1,
"title": "Return of the Jedi",
"director": "Richard Marquand",
"releaseDate": "1983-10-06",
"genre": "Fantasy",
"createdAt": "2024-12-14T12:00:00.000Z"
}
```

### 7. `DELETE /films/{id}`

**Description**: Deletes a movie from the catalog by its ID.

**Expected response**:

```bash
{
"id": 1,
"title": "Return of the Jedi",
"director": "Richard Marquand",
"releaseDate": "1983-10-06",
"genre": "Science Fiction/Fantasy",
"createdAt": "2024-12-14T12:00:00.000Z"
}
```