Přístup k obrázkům produktů

GET /api/pictures

Získání obrázků produktů z databáze.

Požadavek

Příklad: /api/picutres?orderBy=name&desc=true
Získá obrázky produktů dle názvu.

Odpověď (application/json)

200 OK

Stránka se záznamy typu picture.

{
  "items": [
    {
      "name": "chleba.jpg",
      "contentType": "image/jpeg",
      /* ... */
    }
    /* ... */
  ]
}

POST /api/pictures

Vytvoření nového obrázku.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující nový obrázek. Musí obsahovat parametr name a content, název a data obrázku.

Odpověď (application/json)

201 OK CREATED

Tělo odpovědi bude tentýž obrázek, ale už v podobě, jaká byla zapsán do databáze.

V http hlavičce Location bude URL k získání obrázku v pozdějších dotazech.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

GET /api/pictures/{name}

Získání jednoho obrázku s konkrétním názvem. př:

GET /api/pictures/chleba.jpg

získáte obrázek s názvem chleba.jpg (pokud takový existuje).

Odpověď (application/json)

200 OK

Tělo odpovědi bude picture s požadovaným názvem.

404 NOT FOUND

Požadovaný obrázek v databázi neexistuje.

GET /api/pictures/{name}/content

Získání obsahu souboru.

Odpověď (*/* Content-Type odpovídající danému souboru)

200 OK

V těle odpovědi bude obsah souboru.

404 NOT FOUND

Obrázek s názvem {name} neexistuje.

PUT /api/pictures/{name}

Aktualizace obrázku. Existující kategorie s názvem chleba.jpg bude přepsán daty v těle požadavku.

Požadavek (application/json)

Tělo požadavku musí být JSON objekt, reprezentující nový obrázek.

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze obrázku, jak ji systém zapsal do databáze.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

404 NOT FOUND

Aktualizovaný obrázek v databázi neexistuje.

PATCH /api/pictures/{name}

Aktualizace obrázku. Existující obrázek s názvem name bude aktualizována pomocí dat v těle požadavku. Na rozdíl od předchozího volání metodou PUT nemusíte u metody PATCH zasílat kompletní JSON s kategorií, ale stačí poslat jen ty údaje, které chcete změnit.

Příklad:

    PATCH /api/pictures/chleba.jpg

    { "contentType": "image/gif" }

U obrázku s názvem chleba.jpg dojde ke změně typu na "image/gif".

Odpověď (application/json)

200 OK

Tělo odpovědi bude nová verze obrázku, jak ji systém zapsal do databáze.

400 BAD REQUEST

Zaslaný objekt neprošel validací a nemůže být zapsán do databáze. Tělo obsahuje standardní chybový JSON s popisem nalezených chyb.

404 NOT FOUND

Aktualizovaný obrázek v databázi neexistuje.