API Dokumentation - SakurAni/Library GitHub Wiki

Book

GET 200 - OK /api/book/
BESCHREIBUNG

Liefert eine Liste aller vorhadenen Bücher zurück.

RESPONSE
[
  {
    "isbn": "string",
    "title": "string",
    "price": double,
    "picture": "string",
    "seriesNumber": int,
    "currency": "string",
    "type": "string"
  }
]
GET 200 - OK /api/book/{string: isbn}
BESCHREIBUNG

Liefert das Buch mit der im Parameter isbn spezifizierte ISBN Nummer zurück.

RESPONSE
{
  "isbn": "string",
  "title": "string",
  "price": double,
  "picture": "string",
  "seriesNumber": int,
  "currency": "string",
  "type": "string"
}
GET 200 - OK /api/book/author/{string: id}
BESCHREIBUNG

Liefert alle Bücher eines Autors zurück. Der Autor wird anhand der übergebenen ID gesucht.

RESPONSE
[
  {
    "isbn": "string",
    "title": "string",
    "price": double,
    "picture": "string",
    "seriesNumber": int,
    "currency": "string",
    "type": "string"
  }
]
POST 201 - CREATED /api/book/
BESCHREIBUNG

Übernimmt alle Werte eines Buches und erstellt einen neuen Eintrag in der Datenbank. Liefert anschließend bei Erfolg das gerade erstellte Buch zurück.

PARAMETER
Parameter Typ Beschreibung
isbn string ISBN-13 des Buches
title string Der Titel des Buches
price double Der Preis des Buches
picture string Der Pfad zum Coverbild des Buches
seriesNumber int? Die Nummer des Buches innerhalb einer Buchreihe. Kann null sein, wenn das Buch zu keiner Reihe gehört
currency string Dreistelliger Währugngscode
type string Der Typ des Buches (z.B. Roman, Comic, Manga, Sachbuch ...)
RESPONSE
{
  "isbn": "string",
  "title": "string",
  "price": double,
  "picture": "string",
  "seriesNumber": int,
  "currency": "string",
  "type": "string"
}
POST 200 - OK /api/book/
BESCHREIBUNG

Übernimmt alle Werte eines Buches und und aktualisiert anhand der ISBN Nummer ein bereits bestehendes Buch. Liefert 404 - Not Found zurück, wenn es noch kein Buch mit entsprechender ISBN Nummer gibt!

PARAMETER
Parameter Typ Beschreibung
isbn string ISBN-13 des Buches
title string Der Titel des Buches
price double Der Preis des Buches
picture string Der Pfad zum Coverbild des Buches
seriesNumber int? Die Nummer des Buches innerhalb einer Buchreihe. Kann null sein, wenn das Buch zu keiner Reihe gehört
currency string Dreistelliger Währugngscode
type string Der Typ des Buches (z.B. Roman, Comic, Manga, Sachbuch ...)
RESPONSE
{
  "isbn": "string",
  "title": "string",
  "price": double,
  "picture": "string",
  "seriesNumber": int,
  "currency": "string",
  "type": "string"
}
POST 204 - NO CONTENT /api/book/{string: isbn}
BESCHREIBUNG

Löscht ein Buch mit der im Parameter isbn spezifizierten ISBN aus der Datenbank.