次の方法で共有

クイック スタート: PostgreSQL でデータ API ビルダーを使用する

このクイック スタートでは、ローカル PostgreSQL データベースを対象とするデータ API ビルダー構成ファイルのセットを作成します。

[前提条件]

ヒント

または、すべての開発者の前提条件が既にインストールされている GitHub Codespaces でこのクイック スタートを開きます。 独自の Azure サブスクリプションを持ち込むだけです。 GitHub アカウントには、ストレージとコア時間のエンタイトルメントが無料で含まれています。 詳細については、GitHub アカウントに含まれるストレージとコア時間に関する記事を参照してください。

GitHub codespaces で開く で開く

Data API Builder CLI をインストールする

NuGet から Microsoft.DataApiBuilder パッケージを .NET ツールとしてインストールします。

  1. dotnet tool installを使用して、--global引数を使用して最新バージョンのMicrosoft.DataApiBuilderをインストールします。

    dotnet tool install --global Microsoft.DataApiBuilder

    注

    パッケージが既にインストールされている場合は、代わりに dotnet tool update を使用してパッケージを更新します。

    dotnet tool update --global Microsoft.DataApiBuilder

  2. --global引数を使用して、ツールがdotnet tool listと共にインストールされていることを確認します。

    dotnet tool list --global

ローカル データベースを構成する

まず、ローカル データベースを構成して実行します。 その後、サンプル データを含む新しいコンテナーをシード処理できます。

  1. Docker Hub から postgres:16 コンテナー イメージの最新のコピーを取得します。

    docker pull postgres:16

  2. パスワードを設定し、ポート 5432 を発行して、Docker コンテナーを起動します。 <your-password>をカスタム パスワードに置き換えます。

    docker run \
    --publish 5432:5432 \
    --env "POSTGRES_PASSWORD=<your-password>" \
    --detach \
    postgres:16

  3. 優先するデータ管理環境を使用してローカル データベースに接続します。 例としては、 pgAdmin、 Azure Data Studio、 Visual Studio Code 用 PostgreSQL 拡張機能などがありますが、これらに限定されません。

    ヒント

    Docker Linux コンテナー イメージに既定のネットワークを使用している場合、接続文字列は Host=localhost;Port=5432;User ID=postgres;Password=<your-password>;可能性があります。 <your-password>は、前に設定したパスワードに置き換えます。

  4. 新しい bookshelf データベースを作成します。

    DROP DATABASE IF EXISTS bookshelf;

CREATE DATABASE bookshelf;

  5. 新しい dbo.authors テーブルを作成し、テーブルに基本データをシード処理します。

    CREATE TABLE IF NOT EXISTS authors
(
    id INT NOT NULL PRIMARY KEY,
    first_name VARCHAR(100) NOT NULL,
    middle_name VARCHAR(100),
    last_name VARCHAR(100) NOT NULL
);

INSERT INTO authors VALUES
    (01, 'Henry', NULL, 'Ross'),
    (02, 'Jacob', 'A.', 'Hancock'),
    (03, 'Sydney', NULL, 'Mattos'),
    (04, 'Jordan', NULL, 'Mitchell'),
    (05, 'Victoria', NULL, 'Burke'),
    (06, 'Vance', NULL, 'DeLeon'),
    (07, 'Reed', NULL, 'Flores'),
    (08, 'Felix', NULL, 'Henderson'),
    (09, 'Avery', NULL, 'Howard'),
    (10, 'Violet', NULL, 'Martinez');

構成ファイルを作成する

DAB CLI を使用してベースライン構成ファイルを作成します。 次に、現在の資格情報を使用して開発構成ファイルを追加します。

  1. dab initを使用して一般的な構成ファイルを作成します。 最初のセクションのデータベース接続文字列に --connection-string 引数を追加します。 <your-password>は、このガイドで前に設定したパスワードに置き換えます。 また、接続文字列に Database=bookshelf 値を追加します。

    dab init --database-type "postgresql" --host-mode "Development" --connection-string "Host=localhost;Port=5432;Database=bookshelf;User ID=postgres;Password=<your-password>;"

  2. dab addを使用して Author エンティティを追加します。

    dab add Author --source "public.authors" --permissions "anonymous:*"

ローカル データベースを使用して API をテストする

次に、Data API Builder ツールを起動して、開発中に構成ファイルがマージされていることを検証します。

  1. dab startを使用してツールを実行し、エンティティの API エンドポイントを作成します。

    dab start

  2. ツールの出力には、実行中の API に移動するために使用するアドレスが含まれている必要があります。

          Successfully completed runtime initialization.
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: <http://localhost:5000>
info: Microsoft.Hosting.Lifetime[0]

    ヒント

    この例では、アプリケーションはポート 5000 でlocalhostで実行されています。 実行中のアプリケーションのアドレスとポートが異なる場合があります。

  3. まず、に対する GET 要求を発行して、API を手動で試します。

    ヒント

    この例では、URL は https://localhost:5000/api/Author。 この URL には、Web ブラウザーを使用して移動できます。

  4. 次に、 /swaggerの Swagger ドキュメント ページに移動します。

    ヒント

    この例では、URL は https://localhost:5000/swagger。 ここでも、Web ブラウザーを使用してこの URL に移動できます。

次のステップ

REST エンドポイント を する