GraphQL-API-er med Spring Boot · leksjon

Dokumentasjon og utforsking av skjemaet

Gjør GraphQL-API-et Deres lett tilgjengelig: skriv god skjemadokumentasjon, bruk introspeksjon, og ta i bruk GraphiQL slik at utviklere enkelt kan oppdage og prøve API-et.

Leksjon 4 av 413 trinn

Dokumentasjon og utforsking av skjemaet er en gratis leksjon i GraphQL-API-er med Spring Boot på CoddyKit. Dette er leksjon 4 av 4. Du kan lese hele leksjonen gratis nedenfor – og deretter øve praktisk i nettleseren med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i GraphQL-API-er med Spring Boot, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i GraphQL-API-er med Spring Boot inneholder totalt 4 leksjoner.

Skjemaet er dokumentasjonen

En av GraphQLs store styrker er at skjemaet er sterkt typet og selvbeskrivende. Med litt omtanke blir skjemaet levende dokumentasjon som aldri avviker fra virkeligheten.

Beskrive typer og felt

Legg til en beskrivelse ved å skrive en strengliteral rett over en type eller et felt i SDL. Verktøy viser disse som innebygd dokumentasjon.

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

Beskrivelser over flere linjer

Strenger med tre anførselstegn gjør det mulig å skrive innholdsrike beskrivelser over flere linjer, noe som passer perfekt når De skal forklare komplekse felt eller bruksnotater.

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

Hva er introspeksjon?

Introspeksjon er GraphQLs innebygde mulighet til å spørre etter sitt eget skjema. Klienter kan spørre hvilke typer, felt og argumenter som finnes, noe som muliggjør autofullføring og dokumentasjon.

En introspeksjonsforespørsel

Feltet __schema returnerer hele typesystemet. Det er slik verktøy som GraphiQL får vite om API-et ditt.

query {
  __schema {
    types { name description }
  }
}

GraphiQL i Spring Boot

Spring for GraphQL leveres med en innebygd GraphiQL-lekeplass. Aktiver den i konfigurasjonen for å få en interaktiv utforsker i nettleseren.

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

Utforske med GraphiQL

GraphiQL kombinerer en spørringsredigerer, live-autofullføring og et dokumentasjonspanel som er bygget fra introspeksjon. Utviklere kan oppdage og kjøre spørringer uten ekstern dokumentasjon.

Avvikle felt på en ryddig måte

I stedet for å fjerne et felt kan De merke det med @deprecated og oppgi en årsak. Verktøy toner det ned og viser meldingen, slik at klienter ledes til erstatningen.

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

Deaktivere introspeksjon i produksjon

Introspeksjon er nyttig under utvikling, men kan eksponere hele skjemaet for angripere. Mange team deaktiverer det i produksjon for å redusere informasjonslekkasje.

spring:
  graphql:
    schema:
      introspection:
        enabled: false

Generere statisk dokumentasjon

For eksterne partnere kan De generere statisk HTML- eller Markdown-dokumentasjon fra skjemaet ved hjelp av verktøy som SpectaQL eller Magidoc. Da får De en gjennomarbeidet referanse uten å eksponere et aktivt endepunkt.

Beste praksis

Gjør API-et enkelt å utforske:

Beskriv alle offentlige typer og felt
Avvikle i stedet for å slette
Bruk GraphiQL under utvikling, og begrens introspeksjon i produksjon
Publiser statisk dokumentasjon for eksterne brukere

Kort kontroll

Test kunnskapene Deres om dokumentasjon.

Besvar den i den interaktive leksjonen

Oppsummering

Du gjorde API-et ditt enkelt å ta i bruk:

Legg til beskrivelser slik at skjemaet dokumenterer seg selv
Introspeksjon driver verktøystøtte og utforsking
GraphiQL gir en interaktiv utforsker under utvikling
Avvikle på en ryddig måte, og begrens introspeksjon i produksjon

God dokumentasjon og gode utforskingsverktøy gjør GraphQL-API-et ditt behagelig å bruke.

Gratis å komme i gang

Lær deg GraphQL-API-er med Spring Boot med en AI-veileder – gratis

Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.

Kurs: 12
Leksjoner: 48

Start læringen gratis Se hele kurset

Ofte stilte spørsmål

Er leksjonen «Dokumentasjon og utforsking av skjemaet» gratis?

Ja – hele teksten i «Dokumentasjon og utforsking av skjemaet» er gratis å lese her på nettet. For å øve interaktivt med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt, og for å låse opp resten av GraphQL-API-er med Spring Boot-kurset, kan du oppgradere til CoddyKit PRO. Kurset i GraphQL-API-er med Spring Boot inneholder totalt 4 leksjoner.

Hva lærer jeg i «Dokumentasjon og utforsking av skjemaet»?

Gjør GraphQL-API-et Deres lett tilgjengelig: skriv god skjemadokumentasjon, bruk introspeksjon, og ta i bruk GraphiQL slik at utviklere enkelt kan oppdage og prøve API-et. Du øver på GraphQL-API-er med Spring Boot med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.

Trenger jeg erfaring for å begynne med GraphQL-API-er med Spring Boot?

Ingen tidligere erfaring er nødvendig. GraphQL-API-er med Spring Boot på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 4 av 4.

Hvor lang tid tar leksjonen «Dokumentasjon og utforsking av skjemaet»?

De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.

Kan jeg skrive og kjøre kode i denne GraphQL-API-er med Spring Boot-leksjonen?

Ja. Alle GraphQL-API-er med Spring Boot-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.

Alle leksjonene i dette kurset

← Tilbake til GraphQL-API-er med Spring Boot