{"id":25021987,"url":"https://github.com/devpaulorcc/restful-api-films","last_synced_at":"2025-04-13T06:21:07.554Z","repository":{"id":267207418,"uuid":"900469918","full_name":"devpaulorcc/restful-api-films","owner":"devpaulorcc","description":"🎬 A RESTful movie API built with NestJS, allowing you to manage movie information such as title, director, release date and genre, with a scalable and modular architecture.","archived":false,"fork":false,"pushed_at":"2025-01-18T17:21:58.000Z","size":208,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T22:51:18.064Z","etag":null,"topics":["nestjs","restful-api","typescript"],"latest_commit_sha":null,"homepage":"https://rest-api-films.onrender.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devpaulorcc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-08T21:03:03.000Z","updated_at":"2025-01-25T22:16:57.000Z","dependencies_parsed_at":"2024-12-09T03:21:00.983Z","dependency_job_id":"39a3a949-9e67-4a95-adcb-63f0b75b268b","html_url":"https://github.com/devpaulorcc/restful-api-films","commit_stats":null,"previous_names":["devpaulorcc/rest-api-films"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Frestful-api-films","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Frestful-api-films/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Frestful-api-films/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Frestful-api-films/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devpaulorcc","download_url":"https://codeload.github.com/devpaulorcc/restful-api-films/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248671364,"owners_count":21143077,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nestjs","restful-api","typescript"],"created_at":"2025-02-05T13:39:19.631Z","updated_at":"2025-04-13T06:21:07.520Z","avatar_url":"https://github.com/devpaulorcc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo-small.svg\" width=\"120\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Description\n\nThis API allows you to manage a list of movies, offering operations to create, read, update, and delete movies in a database.\n\n## Project setup\n\n```bash\n$ npm install\n```\n\n## Compile and run the project\n\n```bash\n# development\n$ npm run start\n\n# watch mode\n$ npm run start:dev\n\n# production mode\n$ npm run start:prod\n```\n\n## Base URL\n\n```bash\nhttps://rest-api-films.onrender.com\n```\n\n## Endpoints\n\n### 1. `GET /`\n\n**Description**: Checks the API status.  \n**Expected response**:\n\n```bash\n{\n    \"code\": 200,\n    \"status\": \"OK\",\n    \"description\": \"An api made for all the functions of a CRUD for films.\"\n}\n```\n\n### 2. `GET /films`\n\n**Description**: List all movies.\n\n**Expected response**:\n\n```bash\n[\n  {\n    \"id\": 1,\n    \"title\": \"O Retorno de Jedi\",\n    \"director\": \"Richard Marquand\",\n    \"releaseDate\": \"1983-10-06T00:00:00.000Z\",\n    \"genre\": \"Ficção científica/Fantasia\",\n    \"createdAt\": \"2024-12-09T02:11:26.909Z\"\n  },\n  {\n    \"id\": 2,\n    \"title\": \"Blade Runner\",\n    \"director\": \"Ridley Scott\",\n    \"releaseDate\": \"1982-06-25T00:00:00.000Z\",\n    \"genre\": \"Ficção científica/Neo-noir\",\n    \"createdAt\": \"2024-12-09T02:12:01.693Z\"\n  },\n  {\n    \"id\": 5,\n    \"title\": \"Um Sonho de Liberdade\",\n    \"director\": \"Frank Darabont\",\n    \"releaseDate\": \"1994-09-22T00:00:00.000Z\",\n    \"genre\": \"Drama\",\n    \"createdAt\": \"2024-12-09T02:40:39.272Z\"\n  },\n  {\n    \"id\": 6,\n    \"title\": \"A Origem\",\n    \"director\": \"Christopher Nolan\",\n    \"releaseDate\": \"2010-07-16T00:00:00.000Z\",\n    \"genre\": \"Ficção Científica\",\n    \"createdAt\": \"2024-12-09T02:41:39.634Z\"\n  }\n  ...\n]\n```\n\n### 3. `GET /films/{id}`\n\n**Description**: Find one movie by id.\n\n**Expected response**:\n\n```bash\n\n  {\n    \"id\": 1,\n    \"title\": \"O Retorno de Jedi\",\n    \"director\": \"Richard Marquand\",\n    \"releaseDate\": \"1983-10-06T00:00:00.000Z\",\n    \"genre\": \"Ficção científica/Fantasia\",\n    \"createdAt\": \"2024-12-09T02:11:26.909Z\"\n  }\n\n```\n\n### 4. `POST /films`\n\n**Description**: Adds a new movie to the catalog.\n\n**Expected request format**:\n\n```bash\n{\n    \"title\": \"Return of the Jedi\",\n    \"director\": \"Richard Marquand\",\n    \"releaseDate\": \"1983-10-06\",\n    \"genre\": \"Science Fiction/Fantasy\"\n}\n```\n\n**Expected response** (on success):\n\n```bash\n{\n    \"id\": 1,\n    \"title\": \"Return of the Jedi\",\n    \"director\": \"Richard Marquand\",\n    \"releaseDate\": \"1983-10-06\",\n    \"genre\": \"Science Fiction/Fantasy\",\n    \"createdAt\": \"2024-12-14T12:00:00.000Z\"\n}\n```\n\n### 5. `PUT /films/{id}`\n\n**Description**: Completely updates a movie by its ID.\n\n**Expected request format**:\n\n```bash\n{\n    \"title\": \"Star Wars: Episode III – Revenge of the Sith\",\n    \"director\": \"George Lucas\",\n    \"releaseDate\": \"2005-05-19\",\n    \"genre\": \"Science Fiction\"\n}\n```\n\n**Expected response**:\n\n```bash\n{\n    \"id\": 1,\n    \"title\": \"Star Wars: Episode III – Revenge of the Sith\",\n    \"director\": \"George Lucas\",\n    \"releaseDate\": \"2005-05-19\",\n    \"genre\": \"Science Fiction\",\n    \"createdAt\": \"2024-12-14T12:00:00.000Z\"\n}\n```\n\n### 6. `PATCH /films/{id}`\n\n**Description**: Partially updates a specific resource of a movie by its ID.\n\n**Expected request format**:\n\n```bash\n{\n    \"genre\": \"Fantasy\"\n}\n```\n\n**Expected response**:\n\n```bash\n{\n    \"id\": 1,\n    \"title\": \"Return of the Jedi\",\n    \"director\": \"Richard Marquand\",\n    \"releaseDate\": \"1983-10-06\",\n    \"genre\": \"Fantasy\",\n    \"createdAt\": \"2024-12-14T12:00:00.000Z\"\n}\n```\n\n### 7. `DELETE /films/{id}`\n\n**Description**: Deletes a movie from the catalog by its ID.\n\n**Expected response**:\n\n```bash\n{\n    \"id\": 1,\n    \"title\": \"Return of the Jedi\",\n    \"director\": \"Richard Marquand\",\n    \"releaseDate\": \"1983-10-06\",\n    \"genre\": \"Science Fiction/Fantasy\",\n    \"createdAt\": \"2024-12-14T12:00:00.000Z\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevpaulorcc%2Frestful-api-films","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevpaulorcc%2Frestful-api-films","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevpaulorcc%2Frestful-api-films/lists"}