GraphQL APIのドキュメント

Question

RESTでは、Swagger、RAMLまたはその他のテクノロジを使用してAPIを文書化し、コンシューマがサーバーとのやりとりなしに読むことができるHTMLドキュメントを生成できます。

GraphQLと同じようなことがありますか？リソースやプロパティのドキュメントを生成する方法はありますか？

Answer 1

に見えます今すぐhttps://www.npmjs.com/package/graphql-docs

GraphQLスキーマのための動的に生成されたドキュメントエクスプローラ。これは、GraphiQLよりもスキーマのより良い概要を提供することを目的としていますが、機能を問い合せることはありません。

また、スキーマファイルまたはGraphQLエンドポイントに基づいて静的なドキュメントファイルを生成することができます：私はGraphQLスキーマを文書化するための静的なページ生成器を見つけ

npm install -g graphql-docs 
graphql-docs-gen http://GRAPHQL_ENDPOINT documentation.html 

Answer 2

私の知っているところでは、GraphQL API用のHTMLドキュメントを自動的に生成するツールはありませんが、これまでに見たようなAPIドキュメントよりも便利なのはGraphiQLです。

GraphiQLを使用すると、GraphQLサーバーのスキーマを対話的に調べて、同時にそのクエリを実行できます。構文強調表示、自動補完機能を備えており、クエリを実行せずに無効になった場合にも表示されます。

静的なドキュメントをお探しの場合は、GraphQLスキーマ言語でスキーマを読むのが非常に便利です。 GraphQL - スキーマイントロスペクションのもう1つの優れた機能のおかげで、アクセス可能な任意のサーバーのスキーマを簡単に印刷できます。

var graphql = require('graphql'); 
var introspectionSchema = {}; // paste schema here 
console.log(graphql.printSchema(graphql.buildClientSchema(introspectionSchema))); 

結果を次のようになります。：単純に（graphql-JSを使用して）そのように結果のイントロスペクションのスキーマを印刷し、サーバーに対してintrospection queryを実行しているよう

# An author 
type Author { 
    id: ID! 

    # First and last name of the author 
    name: String 
} 

# The schema's root query type 
type Query { 

    # Find an author by name (must match exactly) 
    author(name: String!): Author 
} 

Answer 3

を。 GitHub link。

HTMLエクスポートは次のようになります。

GitHub GraphQL doc example