Pet Adoption Backend API

This repository contains the backend API for a pet adoption platform. The API allows users to log in, create new users, index pets from third-party APIs into the database, update pet statuses, and search for pets based on various parameters.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Running the Application
• Testing
• API Routes
  • User Login
  • Create User
  • Index Pets into Database
  • Update Pet Status
  • Get Pets
• Dependencies
• License

Getting Started

Prerequisites

Make sure you have the following software installed on your machine:

• Node.js
• npm

Installation

1. Clone the repository:

   git clone https://github.com/DouglasVolcato/pet-adoption-backend.git

2. Navigate to the project directory:

   cd pet-adoption-backend

3. Install dependencies:

   npm install

4. Fulfill the .env variables

Running the Application

Run the following command to start the application:

npm start

The API will be accessible at http://localhost:3000.

Testing

To run tests, use the following command:

npm test

This will execute unit and integration tests.

API Routes

User Login

• Endpoint: /login
• Method: POST
• Description: User login
• Request Body:

  {
    "email": "[email protected]",
    "password": "password123"
  }

• Responses:
  • 200: Successful login
  • 400: Bad request
  • 500: Internal server error

Create User

• Endpoint: /user
• Method: POST
• Description: Create user
• Request Body:

  {
    "name": "John Doe",
    "email": "[email protected]",
    "password": "password123"
  }

• Responses:
  • 200: Successful creation
  • 400: Bad request
  • 500: Internal server error

Index Pets into Database

• Endpoint: /pet
• Method: POST
• Description: Index pets into the database
• Security: Bearer Token
• Responses:
  • 200: Successful request
  • 401: Unauthorized
  • 500: Internal server error

Update Pet Status

• Endpoint: /pet
• Method: PUT
• Description: Update pet status
• Security: Bearer Token
• Request Body:

  {
    "petId": "12345",
    "newStatus": "free"
  }

• Responses:
  • 200: Successful update
  • 400: Bad request
  • 401: Unauthorized
  • 500: Internal server error

Get Pets

• Endpoint: /pet
• Method: GET
• Description: Get pets
• Parameters:
  • limit (number)
  • offset (number)
  • term (string)
  • category (string, "cats" or "dogs")
  • status (string, "free" or "adopted")
  • createdAt (string)
• Responses:
  • 200: Successful request
  • 400: Bad request
  • 500: Internal server error

Dependencies

• axios
• bcrypt
• body-parser
• cors
• dotenv
• email-validator
• express
• jsonwebtoken
• mongoose
• swagger-ui-express
• uuid

License

This project is licensed under the ISC License - see the LICENSE.md file for details.