nexus

ネクサス

TypeScript および JavaScript 用の、宣言的でコードファーストで厳密に型指定された GraphQL スキーマ構築。

インストール

 npm install nexus graphql

graphqlも追加する必要があることに注意してください。 Nexus はピア依存関係としてそれに固定されます。

特徴

• スキーマを構築するための表現力豊かな宣言型 API
• 完全なタイプセーフティを無料で提供
• 強力なプラグインシステム
• オブジェクトごとにインターフェースフィールドを再宣言する必要はありません
• オプションで、型を名前で参照することが可能です (オートコンプリートを使用)
  スキーマのすべての部分をインポートする必要はありません
• バニラのgraphql-jsタイプと相互運用可能であり、単なるGraphQLSchemaです
  したがって、 apollo-server 、 graphql-middlewareなどの既存のコミュニティ ソリューションにうまく適合します。
• インライン関数リゾルバー
  単純なフィールドのエイリアスを行う必要がある場合
• 自動生成されたgraphql SDLスキーマ
  コードの変更がスキーマにどのような影響を与えるかを確認する場合に最適です
• ドライアップスキーマ設計
  共通フィールドをラップする高レベルの「関数」を作成する

例

 import { queryType , stringArg , makeSchema } from 'nexus'
import { GraphQLServer } from 'graphql-yoga'

const Query = queryType ( {
  definition ( t ) {
    t . string ( 'hello' , {
      args : { name : stringArg ( ) } ,
      resolve : ( parent , { name } ) => `Hello ${ name || 'World' } !` ,
    } )
  } ,
} )

const schema = makeSchema ( {
  types : [ Query ] ,
  outputs : {
    schema : __dirname + '/generated/schema.graphql' ,
    typegen : __dirname + '/generated/typings.ts' ,
  } ,
} )

const server = new GraphQLServer ( {
  schema ,
} )

server . start ( ( ) => `Server is running on http://localhost:4000` )

他の例は/examplesディレクトリにあります。

• githunt-api
• ts-ast-リーダー
• アポロフルスタック
• スターウォーズ
• キッチンシンク

ドキュメント

Nexus のドキュメントはここで見つけることができます。

SDL からの移行

SDL ファーストのアプローチに従って GraphQL サーバーを構築しており、GraphQL Nexus でコードを作成したときにコードがどのように見えるかを確認したい場合は、 SDL コンバーターを使用できます。