KENDETEGN

Automatisk genereret dokumentation

Brug GraphQL Editor til at generere simpel dokumentation for dit skema. Brug vores grænseflade til at oprette komplet dokumentation med understøttelse af markdown online.

01Programmæssigt genereret

GraphQL Editor genererer automatisk grundlæggende dokumentation for dit skema, og du skal blot udfylde beskrivelserne.

automatisk genererede dokumenter

02Let at gennemse

Skriv dokumenter med vores brugervenlige grænseflade. Klik på en type i indholdsfortegnelsen for at rulle til den i skemaet, klik på en type i skemaet for at navigere til dens dokumentation, eller brug blot søgelinjen øverst.

venlig grænseflade

03Fuld understøttelse af markdown

Brug markdown til at tilføje overskrifter, links, tabeller eller kodeblokke til din dokumentation. Stil dine dokumenter for at gøre dem mere læsevenlige og attraktive.

nedslagsstøtte
play button

Videovejledning med funktion

Find ud af, hvor nemt det er at oprette markdown-dokumentation til dit projekt i GraphQl Editor.

Skabelse af dokumenter til dit skema  | GraphQL Editor Tutorial

GraphQL API dokumentation

Det er lidt besværligt at skrive dokumentation, og de fleste programmører bryder sig ikke om at gøre det, så de vil helt sikkert sætte pris på et værktøj, der tilbyder en masse hjælp til det. GraphQL Editor genererer automatisk grundlæggende dokumentation, derfra er det så simpelt som at skrive beskrivelserne ind. Et stort skema uden dokumentation vil være et stort problem og vil betyde en masse arbejde hen ad vejen. Udfyld det i stedet undervejs ved hjælp af vores intuitive navigationsværktøjer og stil det ved hjælp af markdown. En god GraphQL API-dokumentation er den letteste vej til at tiltrække brugere.

LeftCircle
Markdown-dokumentation

Læs om denne funktion i vores Docs

Se dokumenter