API docs by Redocly

Movies API (11.0.0)

Download OpenAPI specification:Download

API for managing movies

Health check

Responses

Response samples

Content type
application/json
{
  • "message": "Server is running"
}

Get all movies or filter by name

Retrieve a list of all movies. Optionally, provide a query parameter "name" to filter by a specific movie name.

query Parameters
name
string

Movie name to search for

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    },
  • "error": "string"
}

Create a new movie

Create a new movie in the system

Request Body schema: application/json
id
integer

Movie ID

name
required
string non-empty

Movie name

year
required
integer [ 1900 .. 2024 ]

Release year

rating
required
number

Rating

director
required
string non-empty

Director

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Inception",
  • "year": 2010,
  • "rating": 7.5,
  • "director": "Christopher Nolan"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    },
  • "error": "string"
}

Get a movie by ID

Retrieve a single movie by its ID

path Parameters
id
required
string

Movie ID

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    },
  • "error": "string"
}

Delete a movie by ID

path Parameters
id
required
string

Movie ID

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Movie {id} has been deleted"
}

Update a movie by ID

Update the details of an existing movie by providing a movie ID

path Parameters
id
required
string

Movie ID

Request Body schema: application/json
id
number

Movie ID

name
string non-empty

Movie name

year
integer [ 1900 .. 2024 ]

Release year

rating
number

Rating

director
string non-empty

Director

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "name": "Inception",
  • "year": 2010,
  • "rating": 7.5,
  • "director": "Christopher Nolan"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "data": {
    },
  • "error": "string"
}