Jak mám správně formátovat JSON odpovědi v GraphQL?

Když děláš GraphQL, tak odpovědi většinou dostáváš ve formátu JSON. Na rozdíl od RESTu, kde si můžeš vybrat, co chceš poslat zpátky, v GraphQL si specifikuješ přesně, co potřebuješ. Odpověď se většinou skládá z dat a případně chyb. Když dotaz proběhne v pořádku, tak dostaneš objekt s daty, kde máš klíče, které odpovídají tomu, co jsi chtěl. Pokud je něco špatně, tak vrátí error pole. Takže vlastně ano, lepší je mít v odpovědi i chyby a statusy, což ti pomůže lépe s debugováním nebo zpracováním na frontendu.

Je dobrý mít strukturovanou odpověď – mělo by být jasné, co je data a co jsou chyby. Třeba typická odpověď by mohla vypadat takhle: { "data": { "user": { "id": "1", "name": "Jan" } }, "errors": null }

Když používáš nějaké knihovny nebo frameworky, tak se můžeš setkat s různými konvencemi. Například Apollo Client má svoje specifika, ale základní principy platí pro všechny. Takže nejdůležitější je držet se standardu JSON a mít jasně definovanou strukturu. Měj na paměti i to, že pokud tvůj server vrátí data v špatném formátu, klient to neparsnou a bude to problém.

U GraphQL je to trochu jiný svět než u RESTu, to máš pravdu. Data se vrací jako JSON, ale struktura odpovědi je určená tím, co si dotazuješ. V zásadě, když pošleš dotaz, server ti vrátí přesně to, co jsi si vyžádal – žádné zbytečné info navíc. Odpověď bude mít obvykle strukturu s hlavním objektem, kde najdeš data, a občas tam může být i pole pro chyby.

Základní struktura vypadá takhle: { "data": { "tvůjObjekt": { "atribut1": "hodnota", "atribut2": "hodnota" } }, "errors": [ { "message": "Chyba!", "locations": [{"line": 1, "column": 2}], "path": ["tvůjObjekt"] } ] }

Data jsou uvnitř klíče "data", ale když něco neklapne, tak se to hodí do klíče "errors". Takže jo, je fajn mít tam i ty chyby, aby bylo jasné, co se stalo. Co se týče specifických knihoven nebo frameworků – většinou ti to dělá automaticky, ale můžeš narazit na nějaké nuance. Pokud používáš Apollo nebo Relay, tak ty už mají nějaké standardy na formátování odpovědí.

Celkově si dej pozor na strukturu dat a snaž se držet toho, co čekáš od serveru. Tím minimalizuješ problémy při parsování na frontendu.

Takže, ohledně formátování JSON odpovědí v GraphQL, není to tak složitý, jak to vypadá. Základní struktura odpovědi je hodně podobná jako u REST API, ale má svoje specifika. Když děláš dotazy, tak vlastně dostáváš JSON objekt, kde jsou data ve struktuře, kterou sis sám definoval v dotazu. Měl bys mít vždycky klíč, kde budeš mít to, co tě zajímá – třeba data a pak uvnitř další objekty nebo pole s tvýma datama. A jo, pokud nastane nějaká chyba, GraphQL ti vrátí ještě errors, což je super pro ladění. Takže bys měl mít jak data, tak chyby v odpovědi.

Co se týče standardů, tak dodržuj konvence jako používat camelCase pro názvy a snaž se udržet konzistenci ve struktuře dat. Když používáš knihovny jako Apollo Client nebo Relay, tak ty už většinou mají nějaké doporučení na formátování odpovědí a práci s datama. To ti může dost usnadnit život. Jo a nezapomeň testovat ty odpovědi na frontendu – pokud to nebude správně parsovat, tak se to rozbije. Takže drž se toho a mělo by to být OK.