aspnet quickstart minapi user profile

QuickStart in Couchbase mit C# und ASP.NET 6 Minimum API

Erstellen Sie eine REST -API mit C# SDK 3 und ASP.NET -Mindest -API von Couchbase

Dieses Repo soll Ihnen beibringen, wie Sie eine Verbindung zu einem Couchbase -Cluster herstellen, um Dokumente zu erstellen, zu lesen, zu aktualisieren und zu löschen und mithilfe des neuen ASP.NET -Minimum -API -Frameworks einfache parametrisierte N1QL -Abfragen zu schreiben.

Die vollständige Dokumentation finden Sie im Couchbase Developer -Portal.

Voraussetzungen

Um dieses vorgebaute Projekt durchzuführen, benötigen Sie:

• Befolgen Sie die Installationsoptionen der Couchbase
• .NET SDK V6+ installiert
• Code -Editor installiert (Visual Studio Professional, Visual Studio für Mac oder Visual Studio Code)

Abhängigkeiten installieren

 cd src/Couchbase.Quickstart
dotnet restore

HINWEIS: NUGET -Pakete Auto Wiederherstellen beim Erstellen des Projekts in Visual Studio Professional und Visual Studio für Mac

Abhängigkeitsinjektionsnuget -Paket

Das Couchbase SDK für .NET enthält ein Nuget -Paket namens Couchbase.Extensions.DependencyInjection CRUD (create, read, update, delete)

Datenbankserverkonfiguration

Die gesamte Konfiguration für die Kommunikation mit der Datenbank wird in der Datei appSettings.development.json gespeichert. Dies umfasst die Verbindungszeichenfolge, den Benutzernamen, den Passwort, den Bucket -Namen, den Colleciton -Namen und den Umfangsnamen. Der Standardbenutzername wird als admin angenommen, und das Standardkennwort wird als P@$$w0rd12 angenommen. Wenn diese in Ihrer Umgebung unterschiedlich sind, müssen Sie sie ändern, bevor Sie die Anwendung ausführen.

Erstellen Sie den Eimer, den Benutzernamen und das Passwort

In diesem Tutorial muss vor dem Ausführen der Anwendung ein Datenbankbenutzer und ein Bucket erstellt werden.

Capella -Benutzer

Folgen Sie für Capella -Benutzer den Anweisungen auf der Dokumentations -Website zum Erstellen eines Bucket namens user_profile . Befolgen Sie als Nächstes den Anweisungen zum Konfigurieren von Datenbankanmeldeinformationen. Nennen Sie es admin mit einem Passwort von P@$$w0rd12 .

Öffnen Sie als nächstes die Datei appsettings.development.json. Suchen Sie die ConnectionString -Eigenschaft und aktualisieren Sie sie so, dass sie Ihren Weiten -Bereich -Netzwerknamen entspricht, der auf der Registerkarte "Capella Portal UI Connect" gefunden wird. Beachten Sie, dass Capella TLS verwendet, sodass die Verbindungszeichenfolge mit Couchbasen starten muss: //. Diese Konfiguration ist nur für Entwicklungsumgebungen ausgelegt.

  "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 -Benutzer, die diesen Anweisungen nicht folgen, erhalten Ausnahmeberger und das Swagger -Portal gibt beim Ausführen der APIs Fehler zurück.

Lokale Installations- und Docker -Benutzer

Für lokale Installations- und Docker -Benutzer folgen Sie den Anweisungen auf der Dokumentations -Website zum Erstellen eines Bucket namens user_profile . Befolgen Sie als Nächstes den Anweisungen zum Erstellen eines Benutzers. Nennen Sie es admin mit einem Passwort von P@$$w0rd12 . Stellen Sie für dieses Tutorial sicher, dass die Full Admin Verwaltungsrechte vorhanden sind, damit die Anwendung Sammlungen und Indizes erstellen kann.

Öffnen Sie als Nächstes die Datei appsettings.development.json und validieren Sie die Konfigurationsinformationen entsprechen Ihrem Setup.

Hinweis: Für Docker- und lokale Couchbase -Installationen muss die Couchbase vor dem Ausführen der ASP.NET -App auf Localhost (http://127.0.0.1:8091) installiert und ausgeführt werden.

Ausführen der Anwendung

Zu diesem Zeitpunkt ist die Anwendung fertig und Sie können sie ausführen:

 cd src/Couchbase.Quickstart
dotnet run

Sobald die Website in Betrieb ist, können Sie Ihren Browser starten und zur Swagger -Startseite gehen, um die APIs zu testen.

Die Tests ausführen

Verwenden Sie die folgenden Befehle, um die Standardintegrationstests auszuführen:

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

Projekt -Setup -Notizen

Dieses Projekt basierte auf dem Standardprojekt ASP.NET -Vorlagen und die Standardwetter -API wurde entfernt.

Abschluss

Das Einrichten einer grundlegenden REST -API in ASP.NET -Minimum -APIs mit Couchbase ist ziemlich einfach. Dieses Projekt erstellt bei Run eine Sammlung, einen Index für unsere parametrisierte N1QL -Abfrage, und zeigt grundlegende CRUD -Operationen, die in den meisten Anwendungen benötigt werden.