aspnet quickstart

與C＃和ASP.NET的Couchbase中的快速啟動

使用C＃和ASP.NET中使用Couchbase Capella的REST API

通常，創建數據庫後的第一步開發人員是創建一個可以執行該數據庫的REST API，該API可以執行，讀取，更新和刪除（CRUD）操作。此存儲庫旨在教您並為您提供一個入門項目（在C＃中使用ASP.NET）來生成這樣的REST API。在數據庫中安裝了Travel-sample bucket後，您可以運行此應用程序，該應用程序是帶有Swagger文檔的REST API，以便您可以學習：

1. 如何使用鍵值操作（KV操作）創建，讀取，更新和刪除文檔。 KV操作是Couchbase獨有的，並提供超快（想想微秒）查詢。
2. 如何使用內置的旅行樣本存儲桶編寫簡單的參數化SQL ++查詢。

完整的文檔可以在Couchbase開發人員門戶網站上找到。

如果您正在尋找使用ASP.NET最小API的快速啟動，則可以在此存儲庫中找到它。

先決條件

要運行這個預建項目，您將需要：

• 帶有旅行樣本桶的Couchbase Capella簇。
  • 要使用自託管的Couchbase群集運行本教程，請參閱附錄。
• .NET SDK V6+已安裝。
  • 確保.NET版本與Couchbase SDK兼容。
• 安裝了代碼編輯器（Visual Studio專業人員，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

依賴注入nuget軟件包

.NET的couchbase SDK包括一個名為Couchbase.Extensions.DependencyInjection的Nuget軟件包，該套件是為ASP.NET之類的環境而設計的，該環境採用配置來連接到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上訪問該應用程序

驗證應用程序

應用程序啟動後，您可以在日誌上查看應用程序的詳細信息。

該應用程序將在您的本地計算機（http：// localhost：8080/index.html）的端口8080上運行。如果您轉到瀏覽器中的URL，您會發現API的誇張文檔。該演示中使用Swagger文檔來展示不同的API端點以及如何調用它們。有關Swagger文檔的更多詳細信息可以在附錄中找到。

運行測試

要運行標準集成測試，請使用以下命令：

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

附錄

數據模型

對於此QuickStart，我們使用分別包含樣品機場，航空公司和航空公司路線的三個集合，機場，航空公司和路線。路線集合將機場和航空公司連接，如下圖所示。我們在快速啟動中使用這些連接來生成直接連接的機場，並連接到目的地機場的航空公司。請注意，這些只是突出顯示如何使用SQL ++查詢來加入集合的示例。

通過添加新實體來擴展API

如果您想在API中添加另一個實體，則這些是要遵循的步驟：

• 在Couchbase存儲桶中創建新實體（集合）。您可以使用SDK或通過Couchbase服務器接口創建集合。
• 定義Controllers文件夾中的文件中的路由，類似於現有路由。
• 在Org.Quickstart.IntegrationTests AirportTests.cs夾中的新文件中添加新路由的測試。

運行自動託管的sochbase群集

如果您使用自動管理的scouchbase群集運行此快速啟動，則需要將旅行樣本數據存儲庫加載到群集中並生成存儲桶的憑據。

您需要在源文件夾中更新AppSettings.development.json文件中的連接字符串和憑據。

注意：在運行ASP.NET應用程序之前，必須安裝和運行Couchbase。

炫耀文檔

Swagger文檔提供了API的清晰視圖，包括端點，HTTP方法，請求參數和響應對象。

單擊單個端點以將其展開並查看詳細信息。這包括端點的描述，可能的響應狀態代碼以及所接受的請求參數。

嘗試API

您可以通過單擊端點旁邊的“嘗試”按鈕來嘗試API。

• 參數：如果端點需要參數，則Swagger UI提供供您填寫的輸入框。這可能包括路徑參數，查詢字符串，標頭或郵政/put請求的主體。

• 執行：輸入所有必要的參數後，可以單擊“執行”按鈕以進行實時API調用。 Swagger UI將將請求發送到API並直接在文檔中顯示響應。這包括響應代碼，響應標頭和響應主體。

型號

Swagger使用模型記錄請求和響應機構的結構。這些模型使用JSON模式定義了預期的數據結構，並有助於理解要發送和期望的數據。