Redirect

Welcome to the movieClubBackend documentation!

CONGRATULATIONS!

You discovered a not so secret endpoint of our API and/or a not so secret page of our documentation.

This page is set to be the default redirect when you access the root endpoint of the API. That means that if you go to / you get here!.

The endpoint is: <path>:<port>/

Example: localhost:3000 or localhost:3000/

If you have come from the deployed api the endpoint was: https://lug-movie-club.herokuapp.com or https://lug-movie-club.herokuapp.com/

You also can get here if you put some endpoint wrongly, like (/user instead of /users).

---

To see the instalation of the api check the README.

To use the deployed API, the base endpoint is https://lug-movie-club.herokuapp.com. When you see <path>:<port> on the documentation just think of it at the base endpoint.

To know how each endpoint works, its responses and behaviors and who can access each of them check this documentation, you can navigate through the Sidebar or with this table of contents below.

I personally recommend you to take a look at the Gettin Started before start using the endpoints.

Table of contents

🏁 Gettin Started

• Home
  • Fields Dictionary
  • Endpoints Dictionary

---

🚩 Endpoints

• Users 👥

  POST

  • Create New User
  • Create Admin User
  • Find user by Email
  • Login user
  GET

  • Return all users
  • Return user by pk
  PUT

  • Update user by pk
  • Update user password by pk
  DELETE

  • Remove user by pk

• Movies 🎬️

  POST

  • Create new movie
  GET

  • Return all movies
  • Return all adult movies
  • Return movie by pk
  • Return popular adult movies with given title
  PUT

  • Update movie by pk
  DELETE

  • Remove movie by pk

• Orders 🧾

  POST

  • Create new order
  GET

  • Return all orders
  • Return order by pk
  • Return popular orders
  DELETE

  • Remove order by pk

---