dodokpeter / reality-estate

0 stars 1 forks source link

Design API - GET /realities/{realityId} #8

Open dodokpeter opened 2 months ago

dodokpeter commented 2 months ago

Popis API endpoint GET /realities/{realityId} slúži na získanie detailov konkrétnej nehnuteľnosti na základe jej unikátneho identifikátora.

Požiadavky Metóda: GET Cesta: /realities/{realityId}

Parametre realityId (povinné): Unikátny identifikátor nehnuteľnosti, ktorú chcete získať.

Odpoveď Kód 200 OK: Úspešná odpoveď vráti detail nehnuteľnosti vo formáte JSON.

Štruktúra objektu odpovede JSON:

{
  "id": "123", // Unikátny identifikátor nehnuteľnosti
  "type": "byt", // Typ nehnuteľnosti (napr. byt, dom)
  "location": "Bratislava", // Lokalita nehnuteľnosti
  "price": 150000, // Cena nehnuteľnosti v eurách
  "rooms": 3, // Počet izieb
  "area": 75, // Rozloha nehnuteľnosti v m²
  "description": "Pekný 3-izbový byt v centre mesta.", // Krátky popis nehnuteľnosti
  "images": [ // Pole URL obrázkov nehnuteľnosti
    "https://priklad.sk/obrazok1.jpg",
    "https://priklad.sk/obrazok2.jpg"
  ]
}

Chybové kódy 404 Not Found: Nehnuteľnosť s daným realityId nebola nájdená. 400 Bad Request: Neplatný alebo chýbajúci identifikátor nehnuteľnosti (realityId). 500 Internal Server Error: Chyba na strane servera.

seidlmatus commented 2 months ago

pridat aspon 1 succes test na api, cez wiremock