ホーム/ データベース設計とAPI設計の密接な関係性

データベース設計とAPI設計の密接な関係性

アプリケーション開発の世界では、データベース設計とAPI設計の調和が Crucial です。この記事では、why これらの2つの要素を並行して開発する必要があるのかについて、簡単な類推と実践的な例を用いて説明します。well-coordinated のデータベースとAPIが、アプリケーションのパフォーマンスと開発効率を向上させる方法を発見してください。

川原 建

• 7 min read

皆さんはピーナッツバターとジャムのサンドイッチを作ったことがあるでしょうか。前端アプリケーションとバックエンドサーバーがパンの2枚のスライスに、データベースとAPIがピーナッツバターとジャムに該当します。これらを正しく塗布しないと、サンドイッチはひどい失敗作となってしまうかもしれません。データベース設計とAPI設計も同様に、アプリケーションが正常に動作するためには、完璧な調和が必要です。

では、データベース設計とAPI設計がどのように密接に関連しているのか、具体例を交えて詳しく解説しましょう。APIを開発する際は、データベースに格納されたデータにアクセスするための橋を構築することになります。どんな良好な関係においても、コミュニケーションが不可欠です。

スキーマとエンドポイント：データベースをAPIルートにマッピングする

まず、データベースのスキーマが必要です。例えば、簡単なブログプラットフォーム用のAPIを構築する場合、ユーザーと投稿という2つの主要なエンティティのデータベーススキーマは次のようになります。

データベース設計（スキーマ）：

-- ユーザーテーブル
CREATE TABLE users (
  id INT PRIMARY KEY AUTO_INCREMENT,
  username VARCHAR(100) NOT NULL,
  email VARCHAR(255) NOT NULL UNIQUE,
  password_hash VARCHAR(255) NOT NULL,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

-- 投稿テーブル
CREATE TABLE posts (
  id INT PRIMARY KEY AUTO_INCREMENT,
  user_id INT NOT NULL,
  title VARCHAR(255) NOT NULL,
  content TEXT NOT NULL,
  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
  FOREIGN KEY (user_id) REFERENCES users(id)
);

この設計では：

  • users テーブルにはユーザーの情報が格納されます。
  • posts テーブルにはブログ投稿が格納され、外部キー (user_id) を使用して users テーブルを参照し（ユーザーとその投稿の関係を示します）。

API設計（エンドポイント）：

このデータとのインタラクション用のAPIを設計する際は、ユーザーと投稿の両方にエンドポイントを公開する必要があります。

  • GET /users/{id} – 特定のユーザーを取得する。
  • POST /users – 新規ユーザーを作成する。
  • GET /users/{id}/posts – 特定のユーザーのすべての投稿を取得する。
  • POST /posts – 新規投稿を作成する。
// ステップ1：必要なモジュールをインポートする
const express = require('express');  
const app = express();  
const mysql = require('mysql');  // データベースに接続するためのMySQLモジュールをインポート
const bodyParser = require('body-parser');  

// ステップ2：MySQLデータベースへの接続を設定する
const db = mysql.createConnection({
  host: 'localhost',
  user: 'root',  // MySQLのユーザー名
  password: 'password',  // MySQLのパスワード
  database: 'blog_db'  // 使用するデータベース名（この場合、'blog_db'）
});

// ステップ3：JSONリクエストを解析するミドルウェア
app.use(bodyParser.json());  // これにより、`req.body` を JSONオブジェクトとしてアクセス可能になる

// ステップ4：ユーザーIDからユーザーの詳細情報を取得するエンドポイント
// '/users/:id' へのリクエスト時に、指定されたIDのユーザーをデータベースから取得する
app.get('/users/:id', (req, res) => {
  const userId = req.params.id;  // URLパラメータからユーザーIDを取得

  // 指定されたIDのユーザーをデータベースから取得するクエリ
  db.query('SELECT * FROM users WHERE id = ?', [userId], (err, result) => {
    if (err) {
      // データベースエラーがあった場合、500エラー応答を送信する
      return res.status(500).send('データベースエラー');
    }
    if (result.length === 0) {
      // 指定されたIDのユーザーが見つからない場合、404応答を送信する
      return res.status(404).send('ユーザーが見つかりません');
    }

    // ユーザーデータをJSON応答として送信する
    res.json(result[0]);
  });
});

// エンドポイント
// ステップ5：特定のユーザーのすべての投稿を取得するエンドポイント
// このルートでは、ユーザーIDを使用してユーザーが作成した投稿をすべて返す
app.get('/users/:id/posts', (req, res) => {
  const userId = req.params.id;  // URLからユーザーIDを抽出

  // ユーザーIDに一致するuser_idを持つ投稿をデータベースから取得するクエリ
  db.query('SELECT * FROM posts WHERE user_id = ?', [userId], (err, result) => {
    if (err) {
      // データベースエラーを処理し、500エラー応答を送信する
      return res.status(500).send('データベースエラー');
    }

    // 投稿のリストをJSON応答として送信する
    res.json(result);
  });
});

// ステップ6：新規投稿を作成するエンドポイント
// このルートでは、リクエストボディからデータを受け取り、新規投稿を作成する
app.post('/posts', (req, res) => {
  const { user_id, title, content } = req.body;  // リクエストボディから投稿データを抽出

  // 'posts'テーブルに新しい投稿を挿入するクエリ
  db.query(
    'INSERT INTO posts (user_id, title, content) VALUES (?, ?, ?)', 
    [user_id, title, content],  // テーブルに挿入する値
    (err, result) => {
      if (err) {
        // データベースエラーがあった場合、500エラー応答を送信する
        return res.status(500).send('データベースエラー');
      }

      // 投稿作成の確認応答を送信し、新規投稿のIDを含める
      res.status(201).send(`投稿ID: ${result.insertId} で投稿が作成されました。`);
    }
  );
});

// ステップ7：サーバーを起動し、3000番ポートでリスンする
app.listen(3000, () => {
  // サーバーが正常に起動した際にコンソールにログを出力する
  console.log('APIは http://localhost:3000 で実行中です');
});

ここで行った処理：

1. /users/:id – IDからユーザーを取得する

  • このエンドポイントは、データベースから特定のユーザーの詳細情報をIDを用いて取得します。
  • SQLクエリ SELECT * FROM users WHERE id = ? を使用して、users テーブルからユーザー情報を取得します。
// IDからユーザーを取得する
app.get('/users/:id', (req, res) => {
  const userId = req.params.id;  // URLパラメータからユーザーIDを抽出

  // 指定されたIDのユーザーをデータベースから取得するクエリ
  db.query('SELECT * FROM users WHERE id = ?', [userId], (err, result) => {
    if (err) {
      // データベースエラーを処理し、500エラー応答を送信する
      return res.status(500).send('データベースエラー');
    }
    if (result.length === 0) {
      // 指定されたIDのユーザーが見つからない場合、404応答を送信する
      return res.status(404).send('ユーザーが見つかりません');
    }

    // ユーザーデータをJSON応答として送信する
    res.json(result[0]);
  });
});
  • データベースクエリ：
    • SQL: SELECT * FROM users WHERE id = ?
    • これにより、指定された id のユーザーのすべての詳細 (*) を取得します。
    • ? は、req.params.id（URLパラメータから取得される値）による実際の id 値のプレースホルダーです。

2. /users/:id/posts – ユーザーのすべての投稿を取得する

  • このエンドポイントは、posts テーブルの user_id 外部キーを使用して、特定のユーザーに属するすべての投稿を取得します。
  • SQLクエリ SELECT * FROM posts WHERE user_id = ? を使用して、user_id に関連する投稿を取得します。
// ユーザーの投稿を取得する
app.get('/users/:id/posts', (req, res) => {
  const userId = req.params.id;  // URLからユーザーIDを抽出

  // 指定されたユーザーのすべての投稿をデータベースから取得するクエリ
  db.query('SELECT * FROM posts WHERE user_id = ?', [userId], (err, result) => {
    if (err) {
      // データベースエラーを処理し、500エラー応答を送信する
      return res.status(500).send('データベースエラー');
    }

    // 投稿のリストをJSON応答として送信する
    res.json(result);
  });
});

データベースクエリ：

  • SQL: SELECT * FROM posts WHERE user_id = ?
  • これにより、posts テーブルから user_id が users テーブルの id に一致する投稿をすべて取得します。
  • posts テーブルの user_id は、投稿を特定のユーザーに関連付けるための外部キーです。

3. POST /posts – 新規投稿を作成する

  • このエンドポイントは、新しいブログ投稿を作成します。リクエストボディから user_id、title、content を取得し、それらのデータを posts テーブルに挿入します。
  • SQLクエリ INSERT INTO posts (user_id, title, content) VALUES (?, ?, ?) を使用して、データベースに投稿を挿入します。
// 新規投稿を作成する
app.post('/posts', (req, res) => {
  const { user_id, title, content } = req.body;  // リクエストボディから投稿データを抽出

  // 'posts' テーブルに新しい投稿を挿入するクエリ
  db.query(
    'INSERT INTO posts (user_id, title, content) VALUES (?, ?, ?)', 
    [user_id, title, content],  // テーブルに挿入する値
    (err, result) => {
      if (err) {
        // データベースエラーを処理し、500エラー応答を送信する
        return res.status(500).send('データベースエラー');
      }

      // 投稿作成の確認応答を送信し、新規投稿のIDを含める
      res.status(201).send(`投稿ID: ${result.insertId} で投稿が作成されました。`);
    }
  );
});

データベースクエリ：

  • SQL: INSERT INTO posts (user_id, title, content) VALUES (?, ?, ?)
  • これにより、新しい投稿データを posts テーブルに挿入し、user_id を通じてユーザーに関連付けます。
  • ? プレースホルダーは、req.body から取得された実際の値 (user_id、title、content) に置き換えられます。

まとめ：APIとデータベースの相互作用

  • /users/:id: IDからユーザー情報を取得する。users テーブルの id を基にデータを SELECT クエリで取得します。
  • /users/:id/posts: 特定のユーザーのすべての投稿を取得する。posts テーブルの user_id 外部キーを使用して、ユーザーに関連付けられた投稿を取得します。
  • POST /posts: 新規投稿を作成し、user_id を使用してユーザーに関連付ける。INSERT クエリを実行して posts テーブルに新しい投稿を保存します。

Express.js APIエンドポイント は、SQLクエリ を使用してデータを查询・操作することで、直接 MySQLデータベース と相互作用します。APIとデータベースの間の関係はきわめて密接で、APIがシームレスにCRUD操作を実行できるようにしています。

このような構造に従うことで、データベーステーブルを直接APIエンドポイントにマッピングします。これは、データベースがデータを保存する方法とAPIがデータを提供する方法を一致させることに尽きます。

関係性：APIはデータベースを反映すべき

データベースでは、1対多の関係があります。1人のユーザーが多くの投稿を持つことができます。posts テーブルの user_id は、投稿を特定のユーザーに関連付ける外部キーです。

APIでこの関係性を反映するために、posts と users テーブルを結合して、各投稿を作成したユーザーのユーザー名などの関連データを取得する必要があります。

関係性を用いたAPIの例（JOINを使用）

投稿とユーザー情報を取得する（JOINを使用）

// ユーザーのすべての投稿とそのユーザー名を取得する
app.get('/users/:id/posts', (req, res) => {
  const userId = req.params.id;
  db.query(
    'SELECT posts.*, users.username FROM posts JOIN users ON posts.user_id = users.id WHERE posts.user_id = ?',
    [userId],
    (err, result) => {
      if (err) return res.status(500).send('データベースエラー');
      res.json(result); // usersテーブルのユーザー名も含めて投稿を返す
    }
  );
});

説明：

  • ルート: /users/:id/posts
  • データベース相互作用: SQL JOIN を使用して posts と users テーブルを結合します。posts.* として posts テーブルのすべてのカラムを選択し、さらに users テーブルの username カラムも選択します。
  • 応答: APIはユーザーが関連する投稿と、各投稿を作成したユーザーの username を含めて返します。

データ型：適切に選択する！

APIを設計する際には、データベースのデータ型がどのようにリターンされフォーマットされるかを考慮する必要があります。例えば、users と posts テーブルの created_at カラムは、データベースではタイムスタンプとして保存されているかもしれませんが、クライアントに生のタイムスタンプを送信するとはユーザーフレンドリーではありません。

タイムスタンプを人間が読みやすい形式にフォーマットしてからリターンする必要があります。

フォーマットされたタイムスタンプを持つAPIの例

created_at フィールドをフォーマットする（読みやすさのため）

// ユーザーのすべての投稿を取得し、フォーマットされたcreated_atタイムスタンプを返す
app.get('/users/:id/posts', (req, res) => {
  const userId = req.params.id;
  db.query('SELECT * FROM posts WHERE user_id = ?', [userId], (err, result) => {
    if (err) return res.status(500).send('データベースエラー');
    
    // created_atタイムスタンプを人間が読みやすい形式にフォーマットする
    result.forEach(post => {
      post.created_at = new Date(post.created_at).toLocaleString(); // タイムスタンプをフォーマット
    });
    
    // フォーマットされたタイムスタンプを持つ投稿を送信する
    res.json(result);
  });
});

説明：

  • ルート: /users/:id/posts
  • データベース相互作用: posts テーブルを查询してユーザーのすべての投稿を取得します。
  • 応答: 投稿を返す前に、結果をループ処理して、JavaScriptの Date().toLocaleString() メソッドを使用して created_at タイムスタンプをフォーマットします。これにより、タイムスタンプが人間が読みやすい形式（例：「2025年4月23日 16:30」）になります。

まとめ：完璧なサンドイッチのように

良いサンドイッチをつくるのと同じように、データベースとAPIを設計する際にはバランスを取ることが重要です。以下に要点をまとめます：

  1. スキーマ = ブループリント: データベーススキーマはAPIエンドポイントに直接影響を与えます。
  2. 関係性 = コネクション: エンティティ間の関係性（例：user_id と posts）をAPIで適切に考慮する必要があります。
  3. データ型 = 一致させる: API応答はデータベース設計と一致するべきで、タイムスタンプのフォーマットを適切に行うなどです。

APIを構築する際は、SQLデータベース から API設計 まで、すべてが同期していることを確認する必要があります。APIが予期しない形式でデータを送信したり、データベーステーブルとAPIエンドポイントの間で名前が一致しないといった問題を避けたいものです。ここ个交易的就是 EchoAPI が役立ちます。

EchoAPIがSQLとAPI設計の同期をどう助けるのか：一貫性が鍵

EchoAPI は、データベースとAPIの間のギャップを埋める強力なツールです。これにより、データベーススキーマとAPIエンドポイントが同じ言語で会話するようになり、設計プロセスの多くの側面を自動化することができます。

EchoAPI は、データベーススキーマを直接読み取り、APIエンドポイントを自動的に整形して、すでに定義されている構造に合わせることができます。これにより、不整合が減少し、フロントエンドとバックエンドの整合性が向上し、フィールド名やデータ型の不一致を心配する時間を大幅に減らすことができます。

EchoAPIを使用すると、SQLとAPIが自然に成長し一緒に育つことができます。余計な労力は必要なく、始める段階からクリーンで予測可能な設計が可能です。

もし、EchoAPIを使用してAPI設計プロセスを効率化し、データベースとAPI間の同期を保証する方法が知りたい場合は、続編をお見逃しなく。実際の例を交えて、このツールの実装方法を詳しく解説します！

無料で始める

ホットトピックス

Postman vs Thunder Client Postmanの代替品 Insomniaの代替品 Brunoで自動テストを行う Thunder Clientの代替品 須のVSCode拡張機能