Automatisch gegenereerde documentatie
Gebruik GraphQL Editor om eenvoudige documentatie voor uw schema te genereren. Gebruik onze interface om volledige markdown-ondersteunde documentatie online te maken.
01Programmatisch gegenereerd
GraphQL Editor genereert automatisch basisdocumentatie voor uw schema, u hoeft alleen de beschrijvingen in te vullen.
02Gemakkelijk bladeren
Schrijf documenten met onze gebruiksvriendelijke interface. Klik op een type in de inhoudsopgave om ernaar toe te bladeren in het schema, klik op een type in het schema om naar de bijbehorende documentatie te navigeren of gebruik gewoon de zoekbalk bovenaan.
03Volledige markdown-ondersteuning
Gebruik markdown om koppen, links, tabellen of codeblokken aan uw documentatie toe te voegen. Style uw documenten om ze leesbaarder en aantrekkelijker te maken.
Functie videohandleiding
Ontdek hoe eenvoudig het is om markdown-documentatie voor uw project te maken in GraphQl Editor.
GraphQL API documentatie
Het schrijven van documentatie is een beetje een gedoe en de meeste programmeurs doen het niet graag, dus ze zullen een tool die daar veel hulp bij biedt zeker waarderen. GraphQL Editor genereert automatisch basisdocumentatie, van daaruit is het zo simpel als het schrijven van de beschrijvingen. Een groot schema zonder documentatie is een groot probleem en betekent een hoop werk in de toekomst. Vul het in plaats daarvan gaandeweg in met behulp van onze intuïtieve navigatiehulpmiddelen en maak het op met markdown. Een goede GraphQL API-documentatie is de gemakkelijkste weg om gebruikers aan te trekken.
Markdown-documentatie
Lees meer over deze functie in onze Documenten