Főbb pontok
- 01Formátázza a lekérdezéseket, mutációkat, előfizetéseket és SDL sémákat az opcionális graphql.js elemzővel.
- 02Validálja a szintaxist, és jelentse meg a pontos sort és oszlopot a hibákhoz — nincs szükség sémára.
- 03A GraphQL megjegyzések (#) az formázáson eltávolított; használj leírás karakterláncokat a megőrzendő dokumentáláshoz.
- 04Teljes egészében a böngészőben fut — a belső API lekérdezések és a szabadalmaztatott sémák magánmaradnak.
Miért formázz GraphQL dokumentumokat?
A GraphQL lekérdezések gyorsan összetettekké válnak — beágyazott töredékek, beágyazott változók, többszörös műveleti meghatározások és SDL típus meghatározások interfészekkel és direktívákkal. A konzisztens formázás gyorsabbá teszi a társak felülvizsgálatát, és könnyebben felfedezi a hiányzó záró zárójeleket vagy az érv eltéréseket egy pillantásra.
A formázó az referencia graphql.js elemzőt használja — az opcionális GraphQL specifikáció verziójában szállított elemzőt. Ez azt jelenti, hogy az itt kapott kanonikus formázás megegyezik azzal, amit a Prettier GraphQL pluginja és a legtöbb GraphQL eszköztár produkál. Bármi, amely itt tisztán elemez, tisztán elemez az Apollo-ban, Relay-ban és graphql-request-ben.
Hogyan formázz meg egy GraphQL dokumentumot
- 01
Illeszd be a GraphQL-t
Illeszd be a lekérdezést, mutációt, előfizetést, töredéket vagy SDL séma meghatározást az input panelba.
- 02
Kattints Formázz
Az elemzőemit a dokumentumot kanonikus behúzással — kétszóköz behúzás, egy mező per sor, konzisztens érv igazítás. Az eredmény megjelenik az output panelben.
- 03
Opcionálisan validálj
Kattints a Validálj gombra az dokumentum formázott kimenet produkálása nélküli elemzésének megerősítéséhez. Az eredmény egy megerősítés vagy a szintaxis hibák listája sor és oszlop számokkal.
- 04
Másold ki az eredményt
Kattints a Másol gombra, hogy megkapd a formázott dokumentumot. Illeszd be a kódtárodba, a PR leírásba vagy egy dokumentáció fájlba.
Biztonságos a belső sémák és API lekérdezésekhez
A graphql.js elemzőt teljes egészében a böngészőben fut. Nem kerül szerver felé semmilyen műveleti szöveg vagy séma meghatározás. Ez biztonságossá teszi a magán mezőneveket vagy a belső típus rendszereket hivatkozó lekérdezéseket formázást, amely nem szeretne kitéve lenni az külső eszközöknek.
Az validáció itt csak szintaktikai — az eszköz ellenőrzi, hogy a dokumentum érvényes GraphQL dokumentum-e, de nem ellenőrzi, hogy az mezőnevek léteznek-e egy valós sémában, hogy a változók párosulnak-e az érv típusokkal vagy hogy a direktívák helyesen alkalmazodnak-e. A séma-tudatos validáláshoz a célsémát a dokumentum mellett kell betölteni.
GraphQL Formázó GYIK
A GraphQL formázása validál egy séma alapján?
Nem — csak szintaxis validálás. Annak ellenőrzésére, hogy az mezőnevek és argumentumok léteznek-e, szükséges a célséma. Ez az eszköz megerősíti, hogy a dokumentum érvényes GraphQL dokumentum-e, semmi több.
A GraphQL megjegyzéseit megőrzik?
Nem. A # karakterrel kezdődő sorok az elemzőtől eltávolított. Használj háromszor idézett leírás karakterláncokat az dokumentáláshoz, amelynek meg kell felelnie az formázásnak.
Mely GraphQL spec verzió támogatott?
Az október 2021 specifikáció, beleértve a OneOf input objektumokat és az @specifiedBy direktívát.
Formázhatom az SDL séma meghatározásokat, nem csak a műveleti dokumentumokat?
Igen. A típus meghatározások, interfész deklarációk, unió típusok, enumok, direktívák és leírások helyesen körbefordulnak a formázón keresztül.
A lekérdezés vagy séma feltöltésre kerül bárhol?
Nem. A graphql.js elemzőt teljes egészében a böngészőben fut — semmi nem hagyja el az eszközt.