generator-jhipster-gql
Top / generator-jhipster-gql概要 †
github †
https://github.com/glutengo/generator-jhipster-gql
このページについて †
このページは、上記GithubのREADMEをgoogle翻訳して、手直ししたものになります。
README †
序章 †
これはJHipsterモジュールであり、JHipsterアプリケーションで使用することを目的としています。
モジュールは
Node.js Blueprint
https://github.com/jhipster/generator-jhipster-nodejs
で構築されており、既存のJHipsterで生成したWebアプリケーションにGraphQLのサポートを追加します。
このジェネレーターを実行すると、サーバーアプリケーション用に
@nestjs/graphql
https://github.com/nestjs/graphql
を使う仕組みがインストールされます。
ユーザーエンティティとアプリケーションに存在する他のすべてのエンティティ用にリゾルバーがインストールされます。
クライアントアプリケーションの場合、
@apollo/client
https://github.com/apollographql/apollo-client
がインストールされます。エンティティに関連するすべてのREST呼び出しが対応するGraphQLリクエストに置き換えられます。
Angular、React、Vueがサポートされています。
前提条件 †
これはJHipsterモジュールであるため、JHipsterがすでにインストールされている必要があります。
また、アプリケーションを最初にNode.jsブループリントでビルドすることを強くお勧めします。
- JHipsterのインストール
https://www.jhipster.tech/installation/
- Node.jsブループリント
https://github.com/jhipster/generator-jhipster-nodejs
NPMを使ったインストール †
npm install -g generator-jhipster-nodejs
アップデートの場合
npm update -g generator-jhipster-nodejs
YARNを使ったインストールの場合 †
yarn global add generator-jhipster-nodejs
アップデートの場合
yarn global upgrade generator-jhipster-nodejs
インストール †
NPMを使用 †
このモジュールをインストールするには：
npm install -g generator-jhipster-gql
このモジュールを更新するには：
npm update -g generator-jhipster-gql
使用法 †
モジュールを実行します †
yo jhipster-gql
オプション †
GraphQLスキーマの場所 †
このオプションは、クライアントアプリケーションでGraphQLタイピング情報を構築するために使用されるスキーマを制御します。
GraphQLエンドポイント †
このオプションは、クライアントアプリケーションから呼び出されるGraphQLエンドポイントを制御します
GraphQLタイプの定義 †
このオプションは、GraphQLタイプと選択セットが定義される場所を制御します。
デフォルトのセットアップ（GraphQL）では、
GraphQL Code Generator Typescript Operations.
https://www.graphql-code-generator.com/docs/plugins/typescript-operations
に助けを借りて、ドキュメント化してます。
あるいは、
TypeScript
オプションの指定で、
graphql-typeop
https://github.com/glutengo/graphql-typeop
の助けを借りて、TypeScript?のクラス定義を格納することができます。
クライアントアプリケーションの特定のエンティティに対してGraphQLを有効にする †
yo jhipster-gql:entity-client-enable <ENTITY_NAME>
クライアントアプリケーションの特定のエンティティに対してGraphQLを無効にする †
yo jhipster-gql:entity-client-disable <ENTITY_NAME>
