GraphQL-rajapinnat Spring Bootilla · Oppitunti

Skeeman dokumentointi ja tutkiminen

Oppitunti 4/413 vaihetta

Skeeman dokumentointi ja tutkiminen on ilmainen GraphQL-rajapinnat Spring Bootilla-oppitunti CoddyKitissä. Tämä on oppitunti 4/4. Voit lukea koko oppitunnin alta ilmaiseksi ja harjoitella sen jälkeen käytännössä selaimessa sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla. Oppitunti kuuluu GraphQL-rajapinnat Spring Bootilla-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. GraphQL-rajapinnat Spring Bootilla-kurssilla on yhteensä 4 oppituntia.

Skeema toimii dokumentaationa

Yksi GraphQL:n tehokkaista ominaisuuksista on, että skeema on vahvasti tyypitetty ja kuvaa itse itsensä. Huolellisesti laadittuna skeemasta tulee elävä dokumentaatio, joka pysyy aina todellisuuden tasalla.

Tyyppien ja kenttien kuvaaminen

Lisää kuvaus kirjoittamalla merkkijonoliteraali suoraan minkä tahansa tyypin tai kentän yläpuolelle SDL:ssä. Työkalut näyttävät nämä kuvaukset sisäisenä dokumentaationa.

type Book {
  "The book's unique identifier"
  id: ID!
  "Full title as printed on the cover"
  title: String!
}

Moniriviset kuvaukset

Kolmella lainausmerkillä ympäröidyt merkkijonot mahdollistavat monipuoliset moniriviset kuvaukset, jotka sopivat erinomaisesti monimutkaisten kenttien tai käyttöohjeiden selittämiseen.

"""
Returns paginated books.
Use first and after for cursor pagination.
"""
books(first: Int, after: String): BookConnection!

Mitä introspektio tarkoittaa?

Introspektio on GraphQL:n sisäänrakennettu ominaisuus, jonka avulla sen omaa skeemaa voi kysellä. Asiakkaat voivat kysyä, mitä tyyppejä, kenttiä ja argumentteja on olemassa, mikä mahdollistaa automaattisen täydennyksen ja dokumentaation.

Introspektiokysely

Erityinen __schema-kenttä palauttaa koko tyyppijärjestelmän. Näin GraphiQL:n kaltaiset työkalut saavat tietoa rajapinnastasi.

query {
  __schema {
    types { name description }
  }
}

GraphiQL Spring Bootissa

Spring for GraphQL sisältää sisäänrakennetun GraphiQL-leikkikentän. Ota se käyttöön asetuksissa, niin saat selaimeen interaktiivisen selaimen.

# application.yml
spring:
  graphql:
    graphiql:
      enabled: true

GraphiQL:llä tutkiminen

GraphiQL yhdistää kyselyeditorin, reaaliaikaisen automaattisen täydennyksen ja introspektion perusteella muodostetun dokumentaatiopaneelin. Kehittäjät voivat löytää ja suorittaa kyselyitä ilman ulkoista dokumentaatiota.

Kenttien hallittu vanhentaminen

Kentän poistamisen sijaan merkitse se @deprecated-merkinnällä ja anna syy. Työkalut himmentävät kentän ja näyttävät viestin, joka ohjaa asiakkaat käyttämään korvaavaa kenttää.

type User {
  fullName: String @deprecated(reason: "Use firstName and lastName")
}

Introspection poistaminen käytöstä tuotannossa

Introspektio on hyödyllinen kehityksessä, mutta se voi paljastaa koko skeemasi hyökkääjille. Monet tiimit poistavat sen käytöstä tuotannossa vähentääkseen tietovuotoja.

spring:
  graphql:
    schema:
      introspection:
        enabled: false

Staattisen dokumentaation luominen

Ulkoisia kumppaneita varten voit luoda skeemasta staattista HTML- tai Markdown-dokumentaatiota SpectaQL:n tai Magidocin kaltaisilla työkaluilla. Näin saat viimeistellyn viitteen ilman julkista live-päätepistettä.

Parhaat käytännöt

Pidä rajapintasi helposti tutkittavana:

Kuvaa jokainen julkinen tyyppi ja kenttä
Merkitse vanhentuneeksi poistamisen sijaan
Käytä GraphiQL:ää kehityksessä ja rajoita introspektio tuotannossa
Julkaise staattinen dokumentaatio ulkoisille käyttäjille

Pikatarkistus

Testaa dokumentaatiota koskevat tietosi.

Vastaa interaktiivisessa oppitunnissa

Kertaus

Teit rajapinnastasi helposti lähestyttävän:

Lisää kuvauksia, jotta skeema dokumentoi itse itsensä
Introspektio mahdollistaa työkalujen toiminnan ja rajapinnan tutkimisen
GraphiQL tarjoaa interaktiivisen selaimen kehityksessä
Vanhenna kentät hallitusti ja rajoita introspektio tuotannossa

Hyvä dokumentaatio ja rajapinnan tutkimiseen tarkoitetut työkalut tekevät GraphQL-rajapinnastasi miellyttävän käyttää.

Aloita maksutta

Opi GraphQL-rajapinnat Spring Bootilla tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit: 12
Oppitunnit: 48

Aloita opiskelu maksutta Näytä koko kurssi

Usein kysytyt kysymykset

Onko oppitunti ”Skeeman dokumentointi ja tutkiminen” ilmainen?

Kyllä – oppitunnin ”Skeeman dokumentointi ja tutkiminen” koko tekstin voi lukea täällä verkossa ilmaiseksi. Jos haluat harjoitella interaktiivisesti sisäänrakennetulla koodieditorilla ja ympäri vuorokauden käytettävissä olevan tekoälytuutorin avulla sekä avata koko GraphQL-rajapinnat Spring Bootilla-kurssin, päivitä CoddyKit PROhon. GraphQL-rajapinnat Spring Bootilla-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”Skeeman dokumentointi ja tutkiminen”?

Tehkää GraphQL-rajapinnastanne helposti lähestyttävä: kirjoittakaa hyvä skeemadokumentaatio, hyödyntäkää introspektiota ja käyttäkää GraphiQL:ää, jotta kehittäjät voivat löytää ja kokeilla rajapintaa… Harjoittelet GraphQL-rajapinnat Spring Bootilla-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni GraphQL-rajapinnat Spring Bootilla-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin GraphQL-rajapinnat Spring Bootilla-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 4/4.

Kuinka kauan ”Skeeman dokumentointi ja tutkiminen”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä GraphQL-rajapinnat Spring Bootilla-oppitunnilla?

Kyllä. Jokainen GraphQL-rajapinnat Spring Bootilla-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

← Takaisin: GraphQL-rajapinnat Spring Bootilla