graphql-development
タイプセーフなクライアント実装、スキーマ設計、ReactおよびNext.jsとの統合など、GraphQL開発に関するガイドラインを提供します。APIの設計から実装まで一貫したベストプラクティスを示し、型安全性を重視したGraphQL開発をサポートします。
description の原文を見る
GraphQL development guidelines with type-safe clients, schema design, and integration with React and Next.js.
SKILL.md 本文
GraphQL Development
あなたは型安全なクライアントとモダンウェブフレームワークを用いたGraphQL開発の専門家です。
基本原則
- スキーマを明確で一貫した命名規則で設計する
- すべてのGraphQL操作で型安全なクライアントを使用する
- 必要なデータのみを取得するようクエリを最適化する
- 適切なエラーハンドリングを実装する
スキーマ設計
型とフィールド
- 型名にはPascalCaseで説明的な名前を使用する
- フィールド名はcamelCaseで記述する
- nullableな型を適切に使用する
- ミューテーション用の入力型を実装する
- 固定値セットに対してはenumを使用する
リレーションシップ
- 明確な接続パターンを定義する
- カーソルベースまたはオフセットパターンのページネーションを実装する
- 共有フィールドにはinterfaceを使用する
- ポリモーフィックな戻り値にはunion型を実装する
クエリ最適化
- 必要なフィールドのみを取得する
- 再利用可能なフィールド選択にはfragmentを使用する
- バッチ処理にはDataLoaderを実装する
- 適切なresolverでN+1クエリを回避する
型安全なクライアント
Genql
- スキーマからTypeScriptの型を生成する
- 型安全なクエリビルダーを使用する
- IDEのオートコンプリートを活用する
Apollo Client
- キャッシュポリシーを適切に設定する
- ローカルステートにはreactive variablesを使用する
- オプティミスティックアップデートを実装する
- ローディングとエラー状態を処理する
urql
- ドキュメントキャッシングを効果的に使用する
- カスタマイズのためにexchangesを実装する
- サブスクリプションを適切に処理する
統合パターン
React
- クエリとミューテーションにhooksを使用する
- コンポーネント内のローディングとエラー状態を処理する
- 適切なキャッシュ更新を実装する
Next.js
- 初期データ取得にServer Componentsを使用する
- 適切なhydrationパターンを実装する
- GraphQL contextで認証を処理する
エラーハンドリング
- スキーマで明確なエラー型を定義する
- resolverから構造化されたエラーを返す
- クライアントでエラーをグレースフルに処理する
- エラーを適切にログする
セキュリティ
- クエリの深さ制限を実装する
- クエリ複雑度分析を使用する
- 入力を検証・サニタイズする
- 適切な認証を実装する
- フィールドレベルの認可を使用する
テスト
- resolverを独立してテストする
- クライアントテストではGraphQLレスポンスをモックする
- CI/CDでスキーマ検証を使用する
- エラーシナリオをテストする
ライセンス: Apache-2.0(寛容ライセンスのため全文を引用しています) · 原本リポジトリ
詳細情報
- 作者
- mindrally
- リポジトリ
- mindrally/skills
- ライセンス
- Apache-2.0
- 最終更新
- 不明
Source: https://github.com/mindrally/skills / ライセンス: Apache-2.0
関連スキル
doubt-driven-development
重要な判断はすべて、本番環境への展開前に新しい視点から対抗的レビューを実施します。速度より正確性が重要な場合、不慣れなコードを扱う場合、本番環境・セキュリティに関わるロジック・取り消し不可の操作など影響度が高い場合、または後でバグを修正するよりも今検証する方が効率的な場合に活用してください。
apprun-skills
TypeScriptを使用したAppRunアプリケーションのMVU設計に関する総合的なガイダンスが得られます。コンポーネントパターン、イベントハンドリング、状態管理(非同期ジェネレータを含む)、パラメータと保護機能を備えたルーティング・ナビゲーション、vistestを使用したテストに対応しています。AppRunコンポーネントの設計・レビュー、ルートの配線、状態フローの管理、AppRunテストの作成時に活用してください。
desloppify
コードベースのヘルスチェックと技術負債の追跡ツールです。コード品質、技術負債、デッドコード、大規模ファイル、ゴッドクラス、重複関数、コードスメル、命名規則の問題、インポートサイクル、結合度の問題についてユーザーが質問した場合に使用してください。また、ヘルススコアの確認、次の改善項目の提案、クリーンアップ計画の作成をリクエストされた際にも対応します。29言語に対応しています。
debugging-and-error-recovery
テストが失敗したり、ビルドが壊れたり、動作が期待と異なったり、予期しないエラーが発生したりした場合に、体系的な根本原因デバッグをガイドします。推測ではなく、根本原因を見つけて修正するための体系的なアプローチが必要な場合に使用してください。
test-driven-development
テスト駆動開発により実装を進めます。ロジックの実装、バグの修正、動作の変更など、あらゆる場面で活用できます。コードが正常に動作することを証明する必要がある場合、バグ報告を受けた場合、既存機能を修正する予定がある場合に使用してください。
incremental-implementation
変更を段階的に実施します。複数のファイルに影響する機能や変更を実装する場合に使用してください。大量のコードを一度に書こうとしている場合や、タスクが一度では完結できないほど大きい場合に活用します。