Jak by měly vypadat správné odpovědi v GraphQL oproti chybovým zprávám?

Správná odpověď v GraphQL by měla mít strukturu, kde je hlavní klíč "data" a v něm jsou výsledky dotazu. Když třeba dotazuješ uživatelská data, tak dostaneš něco jako { "data": { "user": { "id": "123", "name": "Jan" } } }. Je fajn, když odpověď neobsahuje žádné chyby, to znamená, že pole "errors" bude prázdné.

Co se týče chybových zpráv, ty by měly být jasné a informativní. Typická struktura chyby obsahuje pole "errors" s detaily o tom, co se pokazilo. Například můžeš dostat něco jako { "errors": [{ "message": "Nepodařilo se najít uživatele", "locations": [{ "line": 2, "column": 3 }], "path": ["user"] }] }. Je dobrý mít tam i konkrétní zprávu a případně lokalizaci chyby, aby ses v tom lépe vyznal. Ideálně by tam měl být i nějaký kód chyby nebo typ (např. VALIDATION_ERROR), aby bylo jasný, co se stalo.

Celkově je nejlepší mít konzistentní strukturu pro úspěšné odpovědi i chyby, aby se s tím dalo lehce pracovat a nedocházelo k zmatkům. Takže dodržuj standardy a snaž se být co nejvíc informativní.

Odpovědi v GraphQL jsou celkem jednoduchý. Když všechno proběhne v pohodě, server ti vrátí JSON objekt, který má buď "data" klíč s výsledkama, nebo "errors" klíč, pokud něco nefungovalo. Takže úspěšná odpověď je většinou ve formátu:

{ "data": { "user": { "id": "123", "name": "John" } } }

A když se něco posere, vypadá to takhle:

{ "errors": [ { "message": "User not found", "locations": [{"line": 2, "column": 3}], "path": ["user"] } ] }

Dobrý je, když ty chybový zprávy obsahujou víc než jen kód chyby. Měly by mít popis toho, co se stalo, a ideálně i info o tom, kde přesně chyba vznikla (třeba řádek a sloupec). To hodně pomůže při debugu. Takže jo, snažit se mít nějaký standard je fajn – usnadní to práci s API a ušetří spoustu nervů.

U GraphQL odpovědí je to tak, že bys měl mít jasnou strukturu. Když dostaneš úspěšnou odpověď, měla by vypadat asi takhle: vrátí ti objekt s klíčem "data" a pod ním budou výsledky dotazu. Například pokud dotazuješ uživatele, dostaneš něco jako { "data": { "user": { "id": "1", "name": "Jan" } } }. Je fajn, když to je čisté a přehledné.

Co se týče chyb, tam je důležité mít hlášení, která ti dají vědět, co se pokazilo. Mělo by to obsahovat klíč "errors" s polem chyb. Každá chyba by měla mít kód a zprávu. Například: { "errors": [{ "message": "Neplatný token", "code": "UNAUTHORIZED" }] }. Je dobrý, když to říká víc než jen kód chyby, aby ses mohl snadno zorientovat.

Takže shrnutí: úspěšná odpověď má "data", chybové zprávy mají "errors" a měly by v sobě mít nějaké smysluplné informace. Jasně strukturované odpovědi ti pak usnadní práci s API a zabraží zmatkům.