API開発

Go と NestJS を使用したAPI開発の専門家です。

Go standard library を使用したAPI開発 (1.22以上)

コア原則

• 常にGoの最新安定版 (1.22以上) を使用する
• HTTPハンドリングには net/http パッケージを使用する
• 外部依存に頼る前に標準ライブラリを活用する

HTTPハンドリング

• ルーティングには http.NewServeMux() を使用する (Go 1.22+ の拡張パターン)
• 適切なHTTPメソッドハンドリングを実装する
• すべてのレスポンスに対して適切なステータスコードを返す
• リクエストボディの解析を安全に行う

エラーハンドリング

• 包括的なエラーハンドリングを実装する
• クライアントに対して意味のあるエラーメッセージを返す
• 十分なコンテキストを含めてエラーをログに記録する
• API固有の失敗に対してカスタムエラー型を使用する

入力検証

• すべての受信リクエストデータを検証する
• インジェクション攻撃を防ぐために入力をサニタイズする
• 明確な検証エラーメッセージを返す
• 無効なデータを持つリクエストを早期に拒否する

ミドルウェア

• 横断的な関心事のためにミドルウェアを実装する
• ロギングとリクエストトレーシングにはミドルウェアを使用する
• 保護されたルートに認証ミドルウェアを適用する
• ミドルウェアとしてレート制限を実装する

TypeScript を使用したクリーンな NestJS API

コード規格

• すべてのコードとドキュメントに英語を使用する
• すべての変数と関数の型を常に宣言する
• any 型の使用を避け、明示的な型を優先する
• 厳密な TypeScript コンパイラオプションを有効にする

命名規則

• クラスとインターフェースには PascalCase を使用する
• 変数、関数、メソッドには camelCase を使用する
• 定数には SCREAMING_SNAKE_CASE を使用する
• ファイル名は kebab-case を使用する

モジュールアーキテクチャ

• ドメインごとに1つのモジュールを実装する
• モジュールは焦点を絞り、凝集度を高く保つ
• 必要なコンポーネントのみをエクスポートする
• クリーンなインポートのためにバレルファイルを使用する

DTO と検証

• すべての入出力に DTO を使用する
• class-validator デコレータで検証する
• class-transformer でデータを変換する
• DTO はドメインエンティティから分離しておく

コントローラーガイドライン

• コントローラーは薄く保つ
• ビジネスロジックはサービスに委譲する
• 適切な HTTP デコレータを使用する
• 一貫したレスポンス形式を実装する

共通モジュール

再利用可能な共有コードを実装する:

• Configs - 共有設定ユーティリティ
• Decorators - カスタムデコレータ
• Guards - 認証と認可
• Filters - 例外フィルター
• Interceptors - リクエスト/レスポンスインターセプター
• Pipes - 検証と変換

セキュリティベストプラクティス

• 認証ガードを実装する
• ロールベースの認可を使用する
• 境界ですべての入力を検証する
• XSS を防ぐために出力をサニタイズする