Getting started

# Clone this repository
$ git clone https://github.com/LucasDants/NodeJS-ProductsAPI.git

# Access the project folder cmd/terminal
$ cd NodeJS-ProductsAPI

# install the dependencies
$ npm install

# add env file with variables

# Run the application in development mode
$ npm run dev

# The application will open on the port: 3333 - go to http://localhost:3333

# Go to http://localhost:3333/api-docs to have a swagger documentation of the application

Backend routes

/register - This route should register a new customer.

curl --location '{apiURL}/register' \
--header 'Content-Type: application/json' \
--data-raw '{
   "name": "string",
   "email": "string",
   "password": "string"
}'

/login - This route should authenticate a customer.

curl --location '{apiURL}/login' \
--header 'Content-Type: application/json' \
--data-raw '{
	"email": "string",
	"password": "string"
}'

/products - This route should add a new product while maintaining the supplier's reference. (Requires authentication).

curl --location '{apiURL}/products' \
--header 'Authorization: Bearer {token}' \
--form 'title="Hamburguer"' \
--form 'description="Better hamburguer in the city"' \
--form 'price="30"' \
--form 'image=@"/path/to/file"'

/products/{id} - This route should edit the product with the specified ID while maintaining the supplier's reference. (Requires authentication).

curl --location --globoff --request PUT '{apiURL}/products/{id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {token} \
--data '{
	"title": "string",
	"description": "string",
    "price": 0,
    "imageURL": "string"
}'

/products - This route should return a list of all products sorted from newest to oldest, with the option to reverse this order and to only return products from the authenticated supplier (Requires authentication).

curl --location '{apiURL}/products' \
--header 'Authorization: Bearer {token}'

/products/{id} - This route should return the product with the specified ID along with all its details (Requires authentication).

curl --location --globoff '{apiURL}/products/{id}' \
--header 'Authorization: Bearer {token}'

/products/{id} - This route should delete the product with the specified ID.

curl --location --globoff --request DELETE '{apiURL}/products/{id}' \
--header 'Authorization: Bearer {token}'

Explanation

Routes: Routes are responsible for receiving requests, passing them to other layers, and returning a response. They typically handle incoming HTTP requests (e.g., GET, POST, PUT, DELETE), analyze these requests, and direct them to the appropriate controller based on the URL and request method.

Controller: Controllers act as intermediaries between routes and use cases. They have knowledge of both sides and often handle error handling. Controllers receive data from the route, interact with the appropriate use cases to execute necessary business logic, and return a suitable response to the client.

Use Cases: Use cases represent the business logic layer of an application. They contain business rules, validations, calculations, and operations that the application must perform to meet functional requirements. Use cases are invoked by controllers and interact with repositories to access and modify data.

Repository: Repositories are responsible for abstracting data access in the application, such as databases, external services, or any other data source. They provide an interface for data access and manipulation, hiding implementation details. This separation allows business logic in use cases to be decoupled from the data storage layer.

Model: The model represents the data structure of the application, defining how data is organized and stored. Models often directly map to business entities and may include information about data validation.

Singleton: The Singleton Pattern is a design pattern that ensures a class has only one single instance throughout the application. It is useful in scenarios where you want to control access to a shared resource, such as a database connection, a connection pool, or global configuration. Ensuring only one instance exists helps prevent conflicts and concurrency issues.

These concepts are commonly used together to create an organized and scalable application architecture. They help separate concerns, make code more modular, and facilitate software maintenance and testing.

Postman Collection

Open Postman.
Navigate to the Collections tab on the left-hand side.
Click on the "Import" button located in the top-left corner of the screen.
Drag this file into the box

Link to the postman collection

Testing

npm run test

Made with ❤️ by Lucas Dantas.