API – Knihy

Knižní API poskytuje přístup k základním údajům o knihách a autorech evidovaných v databázi DIV.cz. Výpisy jsou stránkované a jednotlivé záznamy odkazují na své detailní endpointy.

Seznam knih

/api/book/

GET /api/book/

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

Stránkování

Výpis používá stránkování pomocí parametrů limit a offset.

  • limit – počet vrácených záznamů
  • offset – pozice, od které se mají záznamy načíst

Příklad:

/api/book/?limit=10&offset=10

Pole knihy

Pole Význam
bookid Interní ID knihy v DIV.cz.
title Název knihy.
author Textové uvedení autora nebo autorů knihy.
language Jazyk knihy, pokud je evidovaný.
book_detail_link Odkaz na detail knihy v API.

Příklad odpovědi

{
    "next": "https://div.cz/api/book/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "bookid": 2,
            "title": "Master KETO Plán",
            "author": "Tým DIV.cz",
            "language": "cs",
            "book_detail_link": "https://div.cz/api/book/2/"
        },
        {
            "bookid": 3,
            "title": "Šachové povídky",
            "author": "Martin Kučera",
            "language": "cs",
            "book_detail_link": "https://div.cz/api/book/3/"
        }
    ]
}

Detail knihy

Každý záznam obsahuje odkaz na detailní API endpoint knihy. 

GET /api/book/<BookID>/

Příklad:

/api/book/2/

Autoři knih

Samostatný endpoint poskytuje seznam autorů a knih, které jsou s daným autorem propojené.

/api/book_authors/

GET /api/book_authors/

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json

Pole autora

Pole Význam
authorid Interní ID autora.
full_name Celé jméno autora.
books Seznam názvů knih propojených s autorem.

Příklad odpovědi autora

{
    "next": "https://div.cz/api/book_authors/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "authorid": 1,
            "full_name": "Kolektiv eKultura",
            "books": [
                "České báje a pověsti pro děti"
            ]
        },
        {
            "authorid": 2,
            "full_name": "Tým DIV.cz",
            "books": [
                "Master KETO Plán"
            ]
        }
    ]
}

Vztah knihy a autora

Knižní databáze umožňuje evidovat více autorů jedné knihy. Endpoint knih proto obsahuje textovou reprezentaci autora, zatímco endpoint autorů poskytuje vlastní záznam autora a seznam propojených knih.

Související endpointy

Související dokumentace