django - graphene-django は動的に API ドキュメントを作成しますか?

Question

Django バックエンド サービスで GraphQL を使用することを検討していますが、API ドキュメントに関する情報があまり見つかりませんでした。おそらくnpmのgraphql-docsのように、 GitHubのAPI docsに似た結果をもたらすドキュメントを動的に生成するためのソリューションが必要です。

graphene-djangoで達成することは可能ですか? そうでない場合、Python 環境の代わりになるものは何ですか?

Answer 1

はい、Graphene に組み込まれているGraphiQLを使用すると、非常に簡単に実行できます。

これを Graphene と統合する方法についての説明は、graphene-python documentation にあります。graphiql=True--- 基本的には、ファイルに API ルートを設定するときにパラメータを追加する必要がありurls.pyます。

セットアップが完了したら、ブラウザーで API エンドポイントに移動すると、API 呼び出しを送信し、API 応答を取得し、クエリとミューテーションの両方のドキュメントを読むための優れたインターフェイスが表示されます。「< Docs」リンクをクリックするまで、ドキュメントは最初は右側に隠されています。