MERKMALE

Auto-generierte Dokumentation

Verwenden Sie den GraphQL Editor, um eine einfache Dokumentation für Ihr Schema zu erstellen. Nutzen Sie unsere Schnittstelle, um eine vollständige markdown-unterstützte Dokumentation online zu erstellen.

01Programmatisch generiert

GraphQL Editor generiert automatisch eine Basisdokumentation für Ihr Schema, Sie müssen nur noch die Beschreibungen ausfüllen.

automatisch generierte Dokumente

02Leicht zu durchsuchen

Schreiben Sie Dokumentationen mit unserer benutzerfreundlichen Oberfläche. Klicken Sie auf einen Typ im Inhaltsverzeichnis, um zu ihm im Schema zu blättern, klicken Sie auf einen Typ im Schema, um zu seiner Dokumentation zu navigieren oder verwenden Sie einfach die Suchleiste oben.

freundliche Schnittstelle

03Vollständige Unterstützung von Markdown

Verwenden Sie Markdown, um Überschriften, Links, Tabellen oder Codeblöcke in Ihre Dokumentation einzufügen. Gestalten Sie Ihre Dokumente, um sie lesbarer und attraktiver zu machen.

Preisnachlässeunterstützung
play button

Video-Tutorial zum Thema

Finden Sie heraus, wie einfach es ist, eine Markdown-Dokumentation für Ihr Projekt im GraphQl Editor zu erstellen.

Erstellen von Dokumenten für Ihr Schema  | GraphQL Editor Tutorial

GraphQL API documentation

Writing documentation is a bit of a hassle and most programmers don’t like doing it, so they’re sure to appreciate a tool that offers a lot of help with that. GraphQL Editor automatically generates basic documentation, from there it's as simple as writing in the descriptions. A big schema without documentation will be a big problem and will mean a ton of work down the line. Instead fill it in as you go using our intuitive navigation tools and style it using markdown. A good GraphQL API documentation is the easiest road to attracting users.

LeftCircle
Markdown-Dokumentation

Lesen Sie mehr über diese Funktion in unseren Docs

Siehe Dokumente