aspnet quickstartダウンロード-ASPNET aspnet quickstartソースコードのダウンロード

aspnet quickstart

その他のカテゴリー

1.0.0

ダウンロード

C＃とasp.netを備えたCouchBaseのQuickStart

C＃およびASP.NETでCouchBase Capellaを使用したREST API

多くの場合、データベースを作成した後に最初のステップ開発者が行うことは、そのデータベースの作成、読み取り、更新、および削除（CRUD）操作を実行できるREST APIを作成することです。このレポは、あなたに教え、スタータープロジェクト（ASP.NETを使用してC＃で）を提供して、そのようなREST APIを生成するように設計されています。データベースに旅行サンプルバケットをインストールした後、このアプリケーションを実行することができます。

キー値操作（KV操作）を使用してドキュメントを作成、読み取り、更新、削除する方法。 KV操作はCouchBaseに固有のものであり、超高速（マイクロ秒を考えてください）クエリを提供します。
ビルトインのトラベルサンプルバケットを使用して、単純なパラメーター化されたSQL ++クエリの書き方。

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

ASP.NET Minimal APIを使用してQuickStartを探している場合は、このレポで見つけることができます。

前提条件

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

トラベルサンプルバケットがロードされたCouchbase Capellaクラスター。
- セルフマネージドカウチベースクラスターを使用してこのチュートリアルを実行するには、付録を参照してください。
.NET SDK V6+インストール。
- .NETバージョンがCouchBase SDKと互換性があることを確認してください。
インストールされたコードエディター（Visual Studio Professional、Visual Studio Code、またはJetBrains Rider）
旅行サンプルのバケツのロード
- 旅行サンプルがCapellaクラスターにロードされていない場合は、Capellaクラスターの指示に従ってロードできます。
  - Couchbase Capellaに旅行サンプルバケットを積み込みます

アプリのセットアップ

アプリケーションを実行するために必要なさまざまな手順を実行します。

クローンリポジトリ

git clone https://github.com/couchbase-examples/aspnet-quickstart.git

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

 cd src/Org.Quickstart.API
dotnet restore

依存関係インジェクションナゲットパッケージ

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

データベース構成のセットアップ

Capellaクラスターへの接続について詳しく知るには、指示に従ってください。

具体的には、次のことを行う必要があります。

データベース資格情報を作成して、アプリケーションで使用される旅行サンプルバケット（読み取りと書き込み）にアクセスします。
アプリケーションが実行されているIPからクラスターへのアクセスを許可します。

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

  "Couchbase" : {
    "BucketName" : " travel-sample " ,
    "ScopeName" : " inventory " ,
    "ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
    "Username" : " Administrator " ,
    "Password" : " P@ssw0rd12 " ,
    "IgnoreRemoteCertificateNameMismatch" : true ,
    "HttpIgnoreRemoteCertificateMismatch" : true ,
    "KvIgnoreRemoteCertificateNameMismatch" : true
  }

注：接続文字列はcouchbases://またはcouchbase:// partを期待しています。

アプリケーションの実行

マシン上で直接

この時点で、依存関係をインストールし、旅行サンプルデータをロードし、資格情報でアプリケーションを構成しました。これでアプリケーションの準備が整い、実行できます。

 cd src/Org.Quickstart.API
dotnet run

Dockerを使用します

Docker画像を作成します

 cd aspnet-quickstart
docker build -t couchbase-aspnet-quickstart .

Docker画像を実行します

 cd aspnet-quickstart
docker run -e DB_CONN_STR= < connection_string > -e DB_USERNAME= < user_with_read_write_permission_to_travel-sample_bucket > -e DB_PASSWORD= < password_for_user > -p 8080:8080 couchbase-aspnet-quickstart

http：// localhost：8080/index.htmlでアプリケーションにアクセスできます

アプリケーションの確認

アプリケーションが起動したら、ログのアプリケーションの詳細を確認できます。

アプリケーションの起動

アプリケーションは、ローカルマシンのポート8080で実行されます（http：// localhost：8080/index.html）。ブラウザのURLに移動すると、APIのSwaggerドキュメントがあります。このデモでは、さまざまなAPIエンドポイントとそれらの呼び出し方法を紹介するために、Swaggerドキュメントが使用されています。 Swaggerドキュメントの詳細については、付録をご覧ください。

スワッガードキュメント

実行中のテスト

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

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

付録

データモデル

このクイックスタートでは、空港、航空会社、サンプル空港、航空会社、航空会社のルートを含む3つのコレクション、航空会社、およびルートを使用しています。ルートコレクションは、下の図に示すように、空港と航空会社を接続します。クイックスタートでこれらの接続を使用して、直接接続された空港と目的地の空港に接続する航空会社を生成します。これらは、SQL ++クエリを使用してコレクションに参加する方法を強調するための単なる例であることに注意してください。

旅行サンプルデータモデル

新しいエンティティを追加してAPIを拡張します

別のエンティティをAPIに追加したい場合は、これらは次の手順です。

CouchBaseバケットに新しいエンティティ（コレクション）を作成します。 SDKまたはCouchBase Serverインターフェイスを使用してコレクションを作成できます。
既存のルートと同様のControllersフォルダー内のファイル内のルートを定義します。
Org.Quickstart.IntegrationTests AirportTests.csの新しいファイルに新しいルートのテストを追加します。

セルフマネージドカウチベースクラスターを実行します

セルフマネージドカウチベースクラスターでこのクイックスタートを実行している場合は、クラスターに旅行サンプルデータバケットをロードし、バケットの資格情報を生成する必要があります。

ソースフォルダーのappsettings.development.jsonファイルの接続文字列と資格情報を更新する必要があります。

注： ASP.NETアプリを実行する前に、CouchBaseをインストールして実行する必要があります。

スワッガードキュメント

Swaggerドキュメントは、エンドポイント、HTTPメソッド、要求パラメーター、応答オブジェクトを含むAPIの明確なビューを提供します。

個々のエンドポイントをクリックして展開し、詳細情報を表示します。これには、エンドポイントの説明、可能な応答ステータスコード、およびそれが受け入れる要求パラメーターが含まれます。

APIを試してみます

エンドポイントの横にある[試行]ボタンをクリックして、APIを試してみることができます。

パラメーター：エンドポイントにパラメーターが必要な場合、Swagger UIは入力ボックスを提供します。これには、パスパラメーター、クエリ文字列、ヘッダー、または投稿/プットリクエストの本文が含まれます。
実行：必要なすべてのパラメーターを入力したら、[実行]ボタンをクリックしてライブAPI呼び出しを作成できます。 Swagger UIはリクエストをAPIに送信し、ドキュメントに直接応答を表示します。これには、応答コード、応答ヘッダー、および応答本体が含まれます。