JavaScript上級

上級 JavaScriptで学ぶAPI設計｜ケーススタディ編

 

導入

最近、あるスタートアップ企業が新しいプロダクトを開発することになりました。彼らは、ユーザーが自分のデータを管理できるようなAPIを設計したいと考えています。このプロジェクトにおけるAPI設計は、単にエンドポイントを作成するだけでなく、ユーザー体験やデータの整合性を考慮したものにする必要があります。今回は、このプロジェクトを通じて、上級レベルのAPI設計について考察します。

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

重要な概念の整理

API設計においては、リソース指向アプローチが一般的です。このアプローチでは、APIの各エンドポイントが特定のリソースに対して操作を行います。例えば、ユーザーリソースに対しては、CRUD（Create, Read, Update, Delete）操作を提供することが求められます。また、エラーハンドリングや認証、バージョニングも重要な要素です。特に、エラーハンドリングはユーザーにとっての体験を大きく左右します。

コード例（JavaScript）


// ユーザー情報を取得するAPIエンドポイントの例
const express = require('express');
const app = express();
const port = 3000;

// 仮のデータベース
let users = [
    { id: 1, name: 'Alice' },
    { id: 2, name: 'Bob' }
];

// ユーザー情報を取得するエンドポイント
app.get('/api/users/:id', (req, res) => {
    const user = users.find(u => u.id === parseInt(req.params.id));
    if (!user) {
        return res.status(404).json({ error: 'User not found' });
    }
    res.json(user);
});

// サーバーの起動
app.listen(port, () => {
    console.log(`Server running at http://localhost:${port}`);
});

コードの行ごとの解説

  1. const express = require(‘express’); – Expressフレームワークをインポートします。
  2. const app = express(); – Expressアプリケーションのインスタンスを作成します。
  3. const port = 3000; – サーバーがリッスンするポート番号を設定します。
  4. let users = […]; – 仮のユーザーデータを定義します。
  5. app.get(‘/api/users/:id’, (req, res) => {…}); – ユーザー情報を取得するGETリクエストのエンドポイントを定義します。
  6. const user = users.find(…); – リクエストパラメータからユーザーを検索します。
  7. if (!user) { return res.status(404)…; } – ユーザーが見つからなかった場合、404エラーレスポンスを返します。
  8. res.json(user); – ユーザー情報をJSON形式で返します。
  9. app.listen(port, () => {…}); – サーバーを起動し、指定したポートでリッスンします。

ケーススタディ編

このスタートアップ企業は、ユーザー情報を管理するためのAPIを設計する際に、特に「ユーザーの削除」に関する落とし穴に直面しました。最初の設計では、ユーザーを単純に削除するエンドポイントを用意していましたが、実際にはデータ整合性の観点から問題がありました。たとえば、他のリソースがそのユーザーに依存している場合、単純に削除することはできません。

そのため、企業は「論理削除」のアプローチを採用しました。具体的には、ユーザーを削除するのではなく、ユーザーのステータスを「非アクティブ」に変更することで、他のリソースとの整合性を維持しました。この変更により、データの履歴を保持しつつ、必要に応じてユーザーを再アクティブ化することも可能になりました。

まとめ

  • API設計においては、リソース指向アプローチが基本となります。
  • エラーハンドリングやデータ整合性を考慮することが重要です。
  • 論理削除のようなアプローチを用いることで、データの整合性を保ちながら柔軟な操作が可能になります。
RELATED POST