TypeScript上級

上級 TypeScriptで学ぶAPI設計｜アンチパターン編

 

導入

API設計は、システム間のコミュニケーションを円滑にするための重要なプロセスです。しかし、実務においてはさまざまなアンチパターンが存在し、これに陥ることでメンテナンス性や拡張性が損なわれることがあります。本記事では、TypeScriptを用いたAPI設計における具体的なアンチパターンを取り上げ、その改善策について考察します。

教科書レベルの解説（API設計）

重要な概念の整理

API設計においては、リソースの定義、エンドポイントの設計、リクエストおよびレスポンスのフォーマットが中心的な要素です。特にRESTful APIでは、リソース指向の設計が求められます。このような設計では、HTTPメソッド（GET、POST、PUT、DELETEなど）を適切に使用し、クライアントとサーバーの役割を明確にすることが重要です。

コード例（TypeScript）


interface User {
    id: number;
    name: string;
    email: string;
}

class UserService {
    private users: User[] = [];

    public getUser(id: number): User | null {
        return this.users.find(user => user.id === id) || null;
    }

    public createUser(user: User): void {
        this.users.push(user);
    }
}

コードの行ごとの解説

  1. interface User: ユーザーのデータ構造を定義しています。
  2. class UserService: ユーザー関連の操作を提供するサービスクラスです。
  3. private users: User[]: ユーザーの配列を保持します。
  4. getUser(id: number): 指定されたIDのユーザーを取得するメソッドです。ユーザーが見つからない場合はnullを返します。
  5. createUser(user: User): 新しいユーザーを配列に追加するメソッドです。

アンチパターン編

上記のコード例には、いくつかの潜在的なアンチパターンが見受けられます。特に、ユーザーの取得と作成を同じクラスで行っている点が挙げられます。この設計は、責任の分離が不十分であり、将来的に機能追加や変更が発生した際に、クラスが肥大化するリスクがあります。

この問題を解決するためには、クラスを分割して、ユーザーの取得と作成を異なるサービスに委譲することが有効です。例えば、UserServiceをUserFetchServiceとUserCreateServiceに分け、それぞれの責任を明確にすることで、メンテナンス性が向上します。

まとめ

  • API設計では、リソースの管理を明確に分離することが重要です。
  • クラスの責任を明確にすることで、将来的な拡張や変更に対応しやすくなります。
  • TypeScriptの特性を活かして、型安全な設計を心がけることで、エラーを未然に防ぐことができます。
RELATED POST