PostgREST API インストールと使い方：初心者向けガイド

開発者がPostgreSQLデータベース上にRESTful APIを構築するためにどれほどの時間を費やしているか、考えたことはありますか？多くの場合、CRUD操作のための定型コードの記述、クエリの処理、セキュリティの確保といった作業が含まれ、プロジェクトの勢いを鈍らせることがあります。ここでPostgREST APIが登場し、最小限の労力でデータベースをすぐに使えるAPIに変える合理的な代替手段を提供します。この包括的なガイドでは、PostgREST APIの基本的な概念から実践的な実装まで、深く掘り下げていきます。開発を加速させたいバックエンドエンジニアの方も、効率を追求するフルスタック開発者の方も、PostgREST APIを習得することでワークフローを変革できるでしょう。

このトピックを一緒に探求する中で、私は実践的な経験から得られた洞察を共有し、各セクションが前のセクションと論理的に繋がるようにします。最終的には、次のプロジェクトにPostgREST APIを統合する準備が整っていると感じていただけるでしょう。それでは、基本から始めましょう。

💡

美しいAPIドキュメントを生成する優れたAPIテストツールをお探しですか？

開発チームが最大限の生産性で連携できる統合されたオールインワンプラットフォームをお探しですか？

Apidogはあなたのすべての要求に応え、Postmanをはるかに手頃な価格で置き換えます！

ボタン

PostgREST APIとは？概要

PostgREST APIは、PostgreSQLデータベースを完全に機能するRESTfulウェブサービスとして自動的に公開するスタンドアロンツールです。Beowulfによって開発され、PostgreSQLのクエリ言語（SQL）の力を活用してHTTPエンドポイントを動的に生成するため、多くの場合、カスタムのサーバーサイドロジックは不要になります。PostgREST APIの核心は、データベースのスキーマ、テーブル、ビュー、ストアドプロシージャをAPIリソースとして解釈し、GET、POST、PUT、DELETEといった標準的なHTTPメソッドを介して作成、読み取り、更新、削除（CRUD）操作を実行できるようにすることです。

PostgREST APIが特に魅力的であるのは、RESTの原則に準拠しつつ、行レベルセキュリティ（RLS）のような高度なPostgreSQL機能を組み込んでいる点です。これにより、きめ細かなアクセス制御が可能です。例えば、URLパラメータを使用してフィルタリング、ソート、ページネーションを含むデータをクエリできます。追加のミドルウェアは必要ありません。このアプローチは、コードの複雑さを軽減するだけでなく、APIがデータベースの変更と自動的に同期されることを保証します。

ORMやAPIフレームワークが主流の状況において、PostgREST APIは「データベースファースト」の哲学で際立っています。OpenAPI（Swagger）ドキュメントをそのままサポートしており、ApidogやSwagger UIのようなツールとの統合が開発者にとって容易です。分析ダッシュボード、モバイルバックエンド、マイクロサービスなど、データ集約型アプリケーションを管理している場合、PostgREST APIはPostgreSQLの堅牢性と共にスケーラブルな軽量で高性能なソリューションを提供します。これから、このAPIがデータ層とクライアントアプリケーション間のギャップをいかにシームレスに埋めるかをご覧いただきます。

PostgREST APIの開始：インストールとセットアップ

PostgREST APIの使用を開始するには、基盤となるPostgreSQLインスタンスが必要です。幸いなことに、特にDockerのようなコンテナ化ツールを使用する場合、セットアップは簡単で、依存関係を分離し、デプロイを簡素化します。まず、お使いのマシンにDocker Desktopがインストールされていることを確認してください。お使いのオペレーティングシステム（macOS、Windows、Linux）用の公式ウェブサイトからダウンロードできます。

Dockerの準備ができたら、必要なイメージをプルします。Docker Desktopを開き、検索バーに移動して、APIサーバー自体用の「postgrest/postgrest」イメージをインストールします。同様に、

「dpage/pgadmin4」を検索してインストールし、PostgreSQLデータベースを視覚的に管理します。

そして、軽量なPostgreSQLコンテナとして「postgres:alpine」をインストールします。これらのコンポーネントがPostgREST APIを取り巻くエコシステムを形成します。

ターミナル経由で手動でPostgreSQLをセットアップする場合（推奨）、以下のコマンドを実行してコンテナを起動します。

docker run --name postgres-1 -e POSTGRES_PASSWORD=password -d -p 5431:5432 postgres:alpine

ここで、「password」を安全な値に置き換えてください。このコマンドはPostgreSQLをポート5431で起動し、内部の5432にマッピングします。成功すると、DockerはコンテナID（長い英数字の文字列）を返します。検証のためにこれをメモしておいてください。docker psを実行してコンテナのステータスを確認します。

PostgREST APIの設定に不可欠なユーザーロールを確認するには、コンテナシェルに入ります。

docker exec -it <container_id> sh

<container_id>をあなたのIDまたはコンテナ名に置き換えてください。シェル内でPostgreSQLに接続します。

psql -U postgres -d postgres

（「postgres」をデフォルトユーザーと仮定しています。カスタマイズされている場合は調整してください。私の場合、「username」に変更されています。）次に、\duでロールを一覧表示します。「postgres」やカスタムロール名を含むこの出力は、後で参照されます。ここで追加のユーザーを作成し、スキーマに対するSELECT、INSERT、UPDATE、DELETEなどの権限を付与できます。

これらの前提条件が整ったら、Docker Composeを使用して環境をオーケストレーションする準備ができています。Docker Composeは、マルチコンテナアプリケーションを定義するYAMLファイルです。プロジェクトディレクトリにdocker-compose.yamlを作成します。

version: "3.9"
services:
  postgres_host:
    image: postgres:alpine
    environment:
      POSTGRES_USER: username
      POSTGRES_PASSWORD: password
      POSTGRES_DB: postgres
    volumes:
      - pgdata:/var/lib/postgresql/data
    ports:
      - "5431:5432"
  pgadmin:
    image: dpage/pgadmin4
    ports:
      - "5050:80"
    depends_on:
      - postgres_host
    environment:
      PGADMIN_DEFAULT_EMAIL: postgres@pgadmin.com
      PGADMIN_DEFAULT_PASSWORD: postgres
  postgrest:
    image: postgrest/postgrest
    depends_on:
      - postgres_host
    ports:
      - "3000:3000"
    environment:
      PGRST_DB_URI: "postgres://username:password@postgres_host:5432/postgres"
      PGRST_DB_SCHEMA: "public"
      PGRST_DB_ANON_ROLE: "username"
volumes:
  pgdata:

「username」と「password」をあなたの設定に合わせてカスタマイズし、匿名アクセス用にPGRST_DB_ANON_ROLEを\du出力のロールに設定します。この設定は、PostgreSQL、pgAdmin、およびPostgREST APIサーバーをリンクします。ファイルを保存し、ターミナル（例：Docker拡張機能をインストールしたVS Codeの統合ターミナル）で以下を実行します。

docker compose up --build

これにより、サービスが構築され、起動します。YAMLの資格情報を使用してhttp://localhost:5050でpgAdminにアクセスし、接続詳細（ホスト名: postgres_host、ポート: 5432、ユーザー名: username、パスワード: password）で「postgres_host」という名前のサーバーを追加して保存します。これで、http://localhost:3000でPostgREST APIが実行され、データベース操作の準備が整いました。

サンプルプロジェクトの構築：PostgREST APIのステップバイステップテスト

PostgREST APIの真価を理解するために、実践的なプロジェクトを構築しましょう。従業員記録を管理するためのシンプルな人事データベースAPIです。この例では、「humans」テーブルに対するCRUD操作を、Dockerでオーケストレーションし、ApidogでAPIテストを行う方法を示します。

ステップ1：環境の準備

Docker Desktopがインストールされ、イメージ（PostgREST、pgAdmin4、postgres:alpine）がプルされた状態で、前述の通りに初期のPostgreSQLコンテナを実行します。docker psで確認し、\duでユーザーロールをメモしておきます。

ステップ2：スタックの構成

VS Codeのようなコードエディタ（シームレスなコンテナ管理のためにDocker拡張機能が強化されています）で、上記のdocker-compose.yamlファイルを作成します。イメージ名が正確に一致していることを確認してください。不一致があると起動が停止する可能性があります。必要に応じてポートを調整しますが、PostgreSQLの外部ポート（5431）は手動設定と一貫させてください。docker compose up --buildで起動します。エラーがないかログを監視してください。正常に起動すると、サービスがポート5431（DB）、5050（pgAdmin）、3000（PostgREST）にバインドされていることが示されます。

ステップ3：pgAdminの設定とテーブルの作成

http://localhost:5050に移動し、YAMLからのPGADMIN_DEFAULT_EMAILとPASSWORDでログインします。

ダッシュボードの下で、

新しいサーバーを追加します。「postgres_host」と名前を付け、

次に「Connection」タブで、ホスト名: postgres_host、ポート: 5432、ユーザー名: username、パスワード: passwordを入力します。保存してインターフェースにアクセスします。

save the new postgres database configuration

テーブルを作成します: Databases > postgres > Schemas > public > Tables に移動し、Tablesを右クリックして「Create > Table」を選択します。「humans」と名前を付けます。「Columns」に以下を追加します。

id: INTEGER, Not Null, Primary Key
name: VARCHAR(50), Not Null
job: VARCHAR(50)

「Save」をクリックします。データを挿入するには、「humans」テーブルを右クリックし、「Scripts > INSERT Script」を選択します。サンプルSQLで変更します。例：

INSERT INTO public.humans (id, name, job) VALUES (1, 'Steph Curry', 'Pro Basketball Player');

実行してレコードを永続化します。

ステップ4：PostgREST APIの利用可能性の確認

ブラウザでhttp://localhost:3000を開きます。/humansのようなリソースをリストアップするSwagger 2.0の仕様ドキュメントが表示されるはずです。これはPostgREST APIが動作しており、スキーマを認識していることの確認です。

ステップ5：Apidogでテスト

Apidogを起動し、新しいプロジェクトを作成し、http://localhost:3000/humans（「humans」はテーブル名に置き換えてください）へのGETリクエストを追加します。リクエストを送信すると、以下のようなJSONが返されます。

[
  {
    "id": 1,
    "name": "Steph Curry",
    "job": "Pro Basketball Player"
  }
]

making a get request in apidog with postgrest

クエリには、クエリパラメータを追加します: キー「name」、値「eq.Steph Curry」（「eq」は等価を意味します）。これにより、一致するレコードにフィルタリングされます。一致しない場合は空の配列が返されます。

testing with postgrest with wrong data — 間違ったデータを使用して検索を実行

using correct data to make a search in apidog with postgrest api — 正しい情報を使用してApidogでPostgREST API検索を実行

ステップ6：CRUD操作の探索

PostgREST APIは、完全なCRUDで輝きます。POST（作成）の場合、ApidogのボディをJSONとして使用します: {"name": "New Employee", "job": "Developer"} を http://localhost:3000/humans に送信します。PUTは、http://localhost:3000/humans?id=eq.1 を使用してパッチ適用されたデータで更新します。DELETEは、http://localhost:3000/humans?id=eq.1 を使用します。ソート（order=name.asc）や制限（limit=5）のような高度なフィルターは使いやすさを向上させます。詳細な例については、公式ドキュメント https://docs.postgrest.org/en/v14/references/api/tables_views.html を参照してください。

この1時間未満で完了するプロジェクトは、PostgREST APIの迅速なプロトタイピングにおける能力を示しています。PostgreSQLでRLSポリシーを追加して、安全なロールベースのアクセスを実現することで、これをスケールアップできます。

よくある質問

Q1. PostgREST APIを実行するためのシステム要件は何ですか？

回答: PostgREST APIにはPostgreSQL 9.4以降が必要です。コンテナ化されたセットアップにはDockerが推奨されます。基本的な操作には少なくとも512MBのRAMが必要で、控えめなハードウェアでも効率的に動作します。

Q2. PostgREST APIは基本的なCRUD以外の複雑なクエリを処理できますか？

回答: はい、埋め込みRPC呼び出しやビューを介してPostgreSQLの完全なSQL機能をサポートしており、結合、集計、カスタム関数をエンドポイントとして公開できます。

Q3. PostgREST APIはどのようにデータセキュリティを確保しますか？

回答: PostgreSQLの行レベルセキュリティとロールベースの権限にネイティブに統合されており、API側の脆弱性なしにデータベースレベルでアクセス制御を強制します。

Q4. PostgREST APIは本番環境に適していますか？

回答: はい、JWT認証、スキーマ分離、複数のインスタンスによる水平スケーリングなどの機能を備えており、完全に適しています。パフォーマンスを監視し、コンプライアンスのためにRLSを適用してください。

Q5. PostgREST APIをフロントエンドフレームワークと統合するにはどうすればよいですか？

回答: AxiosやFetchのようなHTTPクライアントを使用します。React、Vue、またはAngularアプリケーションでタイプセーフティを確保するために、OpenAPI仕様からTypeScript型を生成します。

結論

これまでの探求を振り返ると、PostgREST APIはデータベース駆動型開発のためのエレガントなソリューションとして浮上し、PostgreSQLの強みをアクセス可能なウェブサービスに変換します。簡単なセットアップから洗練されたクエリまで、オーバーヘッドを少なくして堅牢なAPIを提供することを可能にします。サンプルプロジェクトを再現し、さらに実験することをお勧めします。認証を追加して拡張することもできるでしょう。アプリケーションが進化するにつれて、PostgREST APIは俊敏性と信頼性を維持するための不可欠な味方となるでしょう。

💡

ボタン