Skip to content

Latest commit

 

History

History
92 lines (67 loc) · 2.13 KB

README.md

File metadata and controls

92 lines (67 loc) · 2.13 KB
Raw

Dogs Glossary of Images

This project utilizes the Dogs API to fetch data on various dog breeds, images, and breed-related information. The application provides endpoints for retrieving dog breeds, searching breeds by characteristics, and displaying random images of dogs.

Table of Contents

Installation

  1. Clone the repository:

    git clone https://github.com/codelikeagirl29/dogs-api.git
cd dogs-api

  2. Style your project in any way you want to

  3. Go check out the docs

Usage

This API project is designed to provide information on different dog breeds. You can retrieve a list of all dog breeds, fetch random dog images, and get images for specific breeds.

Endpoints

GET /breeds/list

Fetches a list of all dog breeds.

  • URL: /breeds/list
  • Method: GET
  • Response:
    • 200 OK - Returns an array of all dog breeds.
{
  "message": ["affenpinscher", "akita", "beagle", "dalmatian"],
  "status": "success"
}

GET /breeds/image/random

Fetches a random dog image.

  • URL: /breeds/image/random
  • Method: GET
  • Response:
    • 200 OK - Returns a random dog image URL.
{
  "message": "https://images.dog.ceo/breeds/hound-afghan/n02088094_1007.jpg",
  "status": "success"
}

GET /breeds/images

Fetches all images for a specific breed.

  • URL: /breeds/:breed/images
  • Method: GET
  • Parameters:
    • breed: The name of the breed
  • Response:
    • 200 OK - Returns an array of image URLs for the specified breed.
{
  "message": [
    "https://images.dog.ceo/breeds/hound-afghan/n02088094_1007.jpg",
    "https://images.dog.ceo/breeds/hound-afghan/n02088094_1023.jpg"
  ],
  "status": "success"
}

Screenshot

image