Tärkeimmät kohdat
- 01Muotoile kyselyt, mutaatiot, tilaukset ja SDL-skeema käyttäen virallista graphql.js-jäsentiä.
- 02Vahvista syntaksi ja raportoi tarkat rivit ja sarakkeet virheille — skeema ei vaadita.
- 03GraphQL-kommentit (#) poistetaan muotoillessa; käytä kuvauksellisia merkkijonoja dokumentaatiolle, jonka haluat säilyttää.
- 04Suoritetaan kokonaan selaimessasi — sisäiset API-kyselyt ja omistetut skeema pysyvät yksityisiä.
Miksi muotoilla GraphQL-asiakirjat?
GraphQL-kyselyt voivat muuttua nopeasti monimutkaisiksi — sisäkkäisiä fragmentteja, sisäkkäisiä muuttujia, useita operaation määritelmissä ja SDL-tyypin määritelmissä rajapinnoilla ja direktiiveillä. Johdonmukainen muotoilu tekee vertaisarvioinnista nopeampaa ja tekee puuttuvien sulkemishalkojen tai argumenttien epäsuhdan huomattavaksi yhdellä silmäyksellä.
Muotoilija käyttää viitetta graphql.js-jäsentiä — jäsentiä, mitä GraphQL-spesifikaatio toimittaa. Se tarkoittaa, että kanoninen muotoilu, jonka saat täältä, vastaa mitä Prettier GraphQL-laajennuksella ja useimmilla GraphQL-työkaluilla tuotetaan. Mikä tahansa, mikä jäsentyy puhtaasti tässä, jäsentyy puhtaasti Apollossa, Relayssa ja graphql-requestissa.
GraphQL-asiakirjan muotoilu
- 01
Liitä GraphQL
Liitä kysely, mutaatio, tilaus, fragmentti tai SDL-skeeman määritelmä syöttöpaneeliin.
- 02
Klikkaa Muotoile
Jäsennin lähettää asiakirjan kanonisella sisennysllä — kahden välilyönnin sisennys, yksi kenttä rivillä, johdonmukainen argumentti tasaus. Tulos näkyy lähtöpaneelissa.
- 03
Vahvista valinnaisesti
Klikkaa Vahvista vahvistaaksesi asiakirjan jäsentymisen tuottamatta muotoiltua lähtötietoa. Tulos on vahvistus tai luettelo syntaksivirheistä rivin ja sarakkeen numeroilla.
- 04
Kopioi tulos
Klikkaa Kopioi muotoillun asiakirjan ottamiseksi. Liitä koodikantoosi, PR-kuvaukseen tai dokumentaatiotiedostoon.
Turvallinen sisäisille skeemoille ja API-kyselyille
graphql.js-jäsennin suoritetaan kokonaan selaimessasi. Mitään operaation tekstiä tai skeeman määritelmää ei lähetetä mihinkään palvelimelle. Se tekee siitä turvallisen muotoilla kyselyitä, jotka viittaavat yksityisiin kenttien nimiin tai sisäisiin tyyppijärjestelmiin, joita et halua altistaa kolmannen osapuolen työkaluille.
Vahvistus tässä on vain syntaktinen — työkalu tarkastaa, että asiakirja on kelvollinen GraphQL-asiakirja, mutta se ei tarkasta, että kentän nimet olemassa todellisessa skeemassa, olivatko muuttujat sovittu argumenttityyppeihin tai olivatko direktiivit sovellettu oikein. Skeema-tietoinen vahvistus vaatii kohdealuksen skeemaa ladattavaksi asiakirjan kanssa.
GraphQL-muotoilija — UKK
Vahvistaako GraphQL-muotoilu skeemaa vastaan?
Ei — vain syntaksin vahvistus. Tarkastuksessa kentän ja argumenttien olemassaolon vaatii kohdeskeema. Tämä työkalu vahvistaa asiakirjan kelvolliseksi GraphQL-asiakirjaksi, ei mitään muuta.
Säilytetäänkö GraphQL-kommentit?
Ei. Rivit, jotka alkavat # poistetaan jäsentimellä. Käytä kolminkertaistu lainattua kuvaus-merkkijonoja dokumentaatiolle, joka tulisi selviytyä muotoilusta.
Mitä GraphQL-spesifikaation versiota tuetaan?
Lokakuun 2021 spesifikaatio, mukaan lukien OneOf-syöttöjä ja @specifiedBy-direktiiviä.
Voinko muotoilla SDL-skeeman määritelmät, ei vain operaation asiakirjoja?
Kyllä. Tyyppi-määritelmät, rajapinta-julistukset, unioni-tyypit, enum-arvot, direktiivit ja kuvaukset kaikki kiertyy oikein muotoilun läpi.
Lähetetäänkö kysely tai skeema minnekään?
Ei. graphql.js-jäsennin toimii kokonaan selaimessasi — mitään ei lähde laitteesta.