特徴
自動生成されたドキュメンテーション
GraphQL Editor を使用して、スキーマの簡単なドキュメントを生成します。マークダウンをサポートする完全なドキュメントをオンラインで作成するには、私たちのインターフェイスを使用してください。
01プログラムによる生成
GraphQL Editorはスキーマの基本的なドキュメントを自動的に生成しますので、あとは記述を埋めていくだけです。
02閲覧しやすい
ユーザーフレンドリーなインターフェースでドキュメントを作成できます。目次の中の型をクリックすると、スキーマの中のその型にスクロールします。スキーマの中の型をクリックすると、その型のドキュメントに移動します。
03マークダウンをフルサポート
マークダウンを使用して、ヘッダー、リンク、テーブル、コードブロックをドキュメントに追加してください。ドキュメントをより読みやすく、より魅力的にするために、スタイルを設定します。
機能ビデオチュートリアル
GraphQl Editorでプロジェクトのマークダウンドキュメントを簡単に作成する方法をご紹介します。
スキーマのドキュメントを作成する |GraphQL Editor Tutorial
GraphQL API ドキュメント
ドキュメントを書くのは少し面倒で、ほとんどのプログラマーはそれを好まないので、そのための多くの手助けを提供するツールを高く評価することでしょう。GraphQL Editorは自動的に基本的なドキュメントを生成し、そこからは説明を書き込むだけというシンプルさです。ドキュメンテーションのない大きなスキーマは大きな問題で、後々大変な作業になります。その代わりに、直感的なナビゲーションツールを使って、マークダウンを使ってスタイル化しながら埋めていきましょう。優れたGraphQL APIドキュメントは、ユーザーを惹きつける最も簡単な道です。
Markdown ドキュメント
この機能については、Docsをお読みください。