Graphdoc - GraphQLスキーマからドキュメントを生成
Web APIとしてGraphQLを提供するサービスが増えています。従来のREST APIでは限界のあった、データ構造の自由さに対応するにはGraphQLがベストな選択でしょう。しかしREST APIとは異なるために、求められる情報も変わってきます。 そこで使ってみたいのがGraphdocです。GraphQLのスキーマを使ってWeb APIドキュメントを生成します。
Graphdocの使い方
トップページです。
スキーマの定義を確認できます。
ミューテーション。
型について。
enumについて。
オブジェクトについて。
Graphdocを使うことで構造が明確になり、指定する条件が分かりやすくなります。GraphQLの場合はREST APIとは異なり、エンドポイントが一つです。そのため構造さえ分かってしまえば、後は自由にクエリを記述できるでしょう。
GraphdocはTypeScript製のオープンソース・ソフトウェア(MIT License)です。
@2fd/graphdoc - Static page generator for documenting GraphQL Schema 2fd/graphdoc: Static page generator for documenting GraphQL Schema