10. diel - Dokumentácia k Node.js API

Táto lekcia poskytuje dokumentáciu pre API databázy filmov vrátane ukážkových požiadaviek a odpovedí. Bude vám užitočná hneď niekoľkokrát:

• Predstavenie API - Ak ste sem prišli ešte pred programovaním API, získate prehľad o tom, ako bude projekt fungovať a jeho tvorba pre vás bude potom jednoduchšia.
• Zhrnutie API - Po dokončení projektu táto lekcia zhŕňa jeho funkčnosť a pomáha zapamätanie princípov RESTful API.
• Tvorba klienta - Pokiaľ programujete klienta k tomuto API, napr. v kurzoch Základy React alebo Základy Angular frameworku, môžete si jednoducho overiť, či posielate správne štruktúrovanú požiadavku alebo aký bude od API formát odpovede.
• Tvorba servera - Pokiaľ programujete server v inej technológii, ale mal by fungovať s klientom, pôvodne tvoreným pre toto API (pozri bod vyššie), môžete si jednoducho skontrolovať, že vaše endpointy vracajú presne to, čo majú. Ako toho API pracujú napr. servery v kurzoch Spring Boot - Filmová databáza alebo ASP.NET Core Web API

API databáza filmov

API spravuje filmy, režisérov a hercov. Routovanie je RESTful (posielame teda požiadavky typu GET, POST, PUT a DELETE). Komunikácia prebieha vo formáte JSON. V prípade chyby API vráti chybový kód 4XX.

Ľudia

API nám umožňuje spravovať režisérov a hercov. Súhrnne o nich hovorí ako o ľuďoch a líšia sa od seba iba atribútom role.

Vytvorenie režiséra

Pošleme požiadavku POST na adresu /api/people, ktorá obsahuje JSON s dátami novej osoby. API vráti ako odpoveď novo vytvorený objekt spolu s ID, ktoré mu priradilo.

{
    "name": "James Cameron",
    "birthDate": "1954-08-16",
    "country": "Kanada",
    "role": "director",
    "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ..."
}

{
    "name": "James Cameron",
    "birthDate": "1954-08-16T00:00:00.000Z",
    "country": "Kanada",
    "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ...",
    "role": "director",
    "_id": "64047109b80ed070c5425fb8",
    "__v": 0
}

{
    "name": "Dwayne Johnson",
    "birthDate": "1972-05-02",
    "country": "USA",
    "role": "actor",
    "biography": "Nejprve atlet a hráč amerického fotbalu, poté wrestler a následně herec."
}

{
    "name": "Dwayne Johnson",
    "birthDate": "1972-05-02T00:00:00.000Z",
    "country": "USA",
    "biography": "Nejprve atlet a hráč amerického fotbalu, poté wrestler a následně herec.",
    "role": "actor",
    "_id": "64047e10b3201657ed2b5977",
    "__v": 0
}

[
    {
        "_id": "64047109b80ed070c5425fb8",
        "name": "James Cameron",
        "birthDate": "1954-08-16T00:00:00.000Z",
        "country": "Kanada",
        "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ...",
        "role": "director",
        "__v": 0
    }
]

[
    {
        "_id": "64047e10b3201657ed2b5977",
        "name": "Dwayne Johnson",
        "birthDate": "1972-05-02T00:00:00.000Z",
        "country": "USA",
        "biography": "Nejprve atlet a hráč amerického fotbalu, poté wrestler a následně herec.",
        "role": "actor",
        "__v": 0
    }
]

{
    "_id": "64047109b80ed070c5425fb8",
    "name": "James Cameron",
    "birthDate": "1954-08-16T00:00:00.000Z",
    "country": "Kanada",
    "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ...",
    "role": "director",
    "__v": 0
}

{
    "name": "James Francis Cameron",
    "birthDate": "1954-08-16",
    "country": "Kanada",
    "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ...",
    "role": "director"
}

{
    "_id": "64047109b80ed070c5425fb8",
    "name": "James Francis Cameron",
    "birthDate": "1954-08-16T00:00:00.000Z",
    "country": "Kanada",
    "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ...",
    "role": "director",
    "__v": 0
}

{
    "_id": "64047109b80ed070c5425fb8",
    "name": "James Francis Cameron",
    "birthDate": "1954-08-16T00:00:00.000Z",
    "country": "Kanada",
    "biography": "Byl chudý řidič kamionu, když začínal. Je pětkrát ženatý ...",
    "role": "director",
    "__v": 0
}

{
    "name": "Star Wars VI",
    "year": 1983,
    "directorID": "64047109b80ed070c5425fb8",
    "actorIDs": ["63d27a785060fe3ab7c1df1a"],
    "isAvailable": true,
    "genres": ["sci-fi"]
}

{
    "name": "Star Wars VI",
    "year": 1983,
    "directorID": "64047109b80ed070c5425fb8",
    "actorIDs": [
        "64047e10b3201657ed2b5977"
    ],
    "genres": [
        "sci-fi"
    ],
    "isAvailable": true,
    "_id": "640471c9b80ed070c5425fbc",
    "dateAdded": "2023-03-05T10:41:13.608Z",
    "__v": 0
}

{
    "_id": "640471c9b80ed070c5425fbc",
    "name": "Star Wars VI",
    "year": 1983,
    "directorID": "64047109b80ed070c5425fb8",
    "actorIDs": [
        "64047e10b3201657ed2b5977"
    ],
    "genres": [
        "sci-fi"
    ],
    "isAvailable": true,
    "dateAdded": "2023-03-05T10:41:13.608Z",
    "__v": 0,
    "director": {
        "_id": "64047109b80ed070c5425fb8",
        "name": "James Francis Cameron"
    },
    "actors": [
        {
            "_id": "64047e10b3201657ed2b5977",
            "name": "Dwayne Johnson"
        }
    ]
}

{
    "name": "Star Wars VI",
    "year": 1983,
    "directorID": "64047109b80ed070c5425fb8",
    "actorIDs": ["63d27a785060fe3ab7c1df1a"],
    "isAvailable": false,
    "genres": ["sci-fi"]
}

{
    "_id": "640471c9b80ed070c5425fbc",
    "name": "Star Wars VI",
    "year": 1983,
    "directorID": "64047109b80ed070c5425fb8",
    "actorIDs": [
        "63d27a785060fe3ab7c1df1a"
    ],
    "genres": [
        "sci-fi"
    ],
    "isAvailable": false,
    "dateAdded": "2023-03-05T10:41:13.608Z",
    "__v": 0
}

    "_id": "640471c9b80ed070c5425fbc",
    "name": "Star Wars VI",
    "year": 1983,
    "directorID": "64047109b80ed070c5425fb8",
    "actorIDs": [
        "63d27a785060fe3ab7c1df1a"
    ],
    "genres": [
        "sci-fi"
    ],
    "isAvailable": false,
    "dateAdded": "2023-03-05T10:41:13.608Z",
    "__v": 0
}

[
    "sci-fi",
    "adventure",
    "action",
    "romantic",
    "animated",
    "comedy"
]

V nasledujúcej lekcii, Bezpečnostné hrozby - Ako správne ukladať heslá v Node.js? , si vysvetlíme bezpečnostné hrozby spojené s ukladaním hesiel používateľov.