aspnet quickstart minapi user profile

C＃とASP.NET 6の最小APIを備えたCouchBaseのQuickStart

CouchBaseのC＃SDK 3およびASP.NET最小APIを使用してREST APIを構築します

このレポは、CouchBaseクラスターに接続してドキュメントを作成、読み取り、更新、削除する方法と、新しいASP.NET最小APIフレームワークを使用して単純なパラメータ化されたN1QLクエリを作成する方法を教えるように設計されています。

完全なドキュメントは、CouchBase Developer Portalにあります。

前提条件

この事前に作成されたプロジェクトを実行するには、次のことが必要です。

• CouchBaseのインストールオプションをフォローして、最新のCouchBaseデータベースサーバーインスタンスをインストールする
• .NET SDK V6+インストール
• コードエディターインストール（Visual Studio Professional、Mac用のVisual Studio、またはVisual Studioコード）

依存関係をインストールします

 cd src/Couchbase.Quickstart
dotnet restore

注：nugetパッケージVisual Studioでプロジェクトを構築するときに自動復元

DependencyInjection Nugetパッケージ

.NET用のCouchBase SDKには、 Couchbase.Extensions.DependencyInjectionと呼ばれるnugetパッケージが含まれています。これは、CouchBaseに接続し、コードで使用して完全なCRUD (create, read, update, delete) 。

データベースサーバー構成

データベースとの通信用のすべての構成は、appsettings.development.jsonファイルに保存されます。これには、接続文字列、ユーザー名、パスワード、バケット名、コレシトン名、およびスコープ名が含まれます。デフォルトのユーザー名はadminであると想定され、デフォルトのパスワードはP@$$w0rd12であると想定されます。これらが環境で異なる場合は、アプリケーションを実行する前に変更する必要があります。

バケット、ユーザー名、パスワードの作成

このチュートリアルを使用すると、アプリケーションを実行する前にデータベースユーザーとバケットを作成する必要があります。

Capellaユーザー

Capellaユーザーの場合、 user_profileというバケットを作成するために、ドキュメントWebサイトにある指示に従ってください。次に、データベース資格情報を構成するための指示に従ってください。 P@$$w0rd12のパスワードでadmin名前を付けます。

次に、appsettings.development.jsonファイルを開きます。 ConnectionStringプロパティを見つけ、Capella Portal UI Connectタブにあるワイドエリアネットワーク名と一致するように更新します。 CapellaはTLSを使用しているため、接続文字列はCouchBase：//で開始する必要があることに注意してください。この構成は、開発環境のみを対象に設計されています。

  "Couchbase" : {
    "BucketName" : " user_profile " ,
    "ScopeName" : " _default " ,
    "CollectionName" : " profile " ,
    "ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
    "Username" : " admin " ,
    "Password" : " P@$$w0rd12 " ,
    "IgnoreRemoteCertificateNameMismatch" : true ,
    "HttpIgnoreRemoteCertificateMismatch" : true ,
    "KvIgnoreRemoteCertificateNameMismatch" :  true
  }

これらの指示に従わないCouchbase Capellaユーザーは例外エラーを取得し、SwaggerポータルはAPIを実行するときにエラーを返します。

ローカルインストールとDockerユーザー

ローカルインストールおよびDockerユーザーの場合、 user_profileというバケットを作成するために、ドキュメントWebサイトにある指示に従ってください。次に、ユーザーを作成するための指示に従ってください。 P@$$w0rd12のパスワードでadmin名前を付けます。このチュートリアルでは、アプリケーションがコレクションとインデックスを作成できるように、 Full Admin権利があることを確認してください。

次に、appsettings.development.jsonファイルを開き、設定に一致する構成情報を検証します。

注： DockerおよびLocal CouchBaseのインストールの場合、ASP.NETアプリを実行する前に、CouchBaseをインストールしてLocalHost（http://127.0.0.1:8091）で実行する必要があります。

アプリケーションの実行

この時点で、アプリケーションの準備が整い、実行できます。

 cd src/Couchbase.Quickstart
dotnet run

サイトが稼働したら、ブラウザを起動し、Swagger Startページに移動してAPIをテストできます。

テストの実行

標準統合テストを実行するには、次のコマンドを使用します。

 cd ../Couchbase.Quickstart.IntegrationTests/
dotnet restore 
dotnet build
dotnet test 

プロジェクトのセットアップノート

このプロジェクトは、標準のASP.NETテンプレートプロジェクトに基づいており、デフォルトの天気APIが削除されました。

結論

CouchBaseを使用したASP.NET最小APIで基本的なREST APIをセットアップするのはかなり簡単です。実行時のこのプロジェクトは、パラメーター化されたN1QLクエリのインデックスであるコレクションを作成し、ほとんどのアプリケーションで必要な基本的なCRUD操作を紹介します。