aspnet quickstart
1.0.0
Oft besteht der erste Schritt, den Entwickler nach dem Erstellen ihrer Datenbank durchführen, eine REST -API, mit der CRUD -Operationen für diese Datenbank erstellt, gelesen, aktualisiert und gelöscht werden können. Dieses Repo soll Ihnen unterrichten und Ihnen ein Starterprojekt (in C# verwenden ASP.NET) zur Generierung einer solchen REST -API. Nachdem Sie den Travel-Sample-Bucket in Ihrer Datenbank installiert haben, können Sie diese Anwendung ausführen, die eine REST-API mit Swagger-Dokumentation ist, damit Sie lernen können:
Die vollständige Dokumentation finden Sie im Couchbase Developer -Portal.
Wenn Sie nach einem QuickStart mit ASP.NET Minimal API suchen, finden Sie ihn in diesem Repo.
Um dieses vorgebaute Projekt durchzuführen, benötigen Sie:
Wir werden die verschiedenen Schritte durchgehen, die erforderlich sind, um die Anwendung zum Laufen zu bringen.
git clone https://github.com/couchbase-examples/aspnet-quickstart.git cd src/Org.Quickstart.API
dotnet restore Das Couchbase SDK für .NET enthält ein Nuget -Paket namens Couchbase.Extensions.DependencyInjection CRUD (create, read, update, delete)
Um mehr über die Verbindung zu Ihrem Capella -Cluster zu erfahren, befolgen Sie bitte die Anweisungen.
Insbesondere müssen Sie Folgendes tun:
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 und den Umfangsnamen. Der Standard -Benutzername wird als Administrator 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.
"Couchbase" : {
"BucketName" : " travel-sample " ,
"ScopeName" : " inventory " ,
"ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
"Username" : " Administrator " ,
"Password" : " P@ssw0rd12 " ,
"IgnoreRemoteCertificateNameMismatch" : true ,
"HttpIgnoreRemoteCertificateMismatch" : true ,
"KvIgnoreRemoteCertificateNameMismatch" : true
}
Hinweis: Die Verbindungszeichenfolge erwartet die
couchbases://odercouchbase://Teil.
Zu diesem Zeitpunkt haben wir die Abhängigkeiten installiert, die Reisebestichdaten geladen und die Anwendung mit den Anmeldeinformationen konfiguriert. Die Anwendung ist jetzt fertig und Sie können sie ausführen.
cd src/Org.Quickstart.API
dotnet run cd aspnet-quickstart
docker build -t couchbase-aspnet-quickstart . 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-quickstartSie können auf die Anwendung auf http: // localhost: 8080/index.html zugreifen
Sobald die Anwendung beginnt, können Sie die Details der Anwendung in den Protokollen sehen.
Die Anwendung wird auf Port 8080 Ihres lokalen Computers ausgeführt (http: // localhost: 8080/index.html). Sie finden die Prahlerei der API, wenn Sie in Ihrem Browser zur URL gehen. In dieser Demo wird die Dokumentation der Swagger verwendet, um die verschiedenen API -Endpunkte und ihre Einbeziehung zu präsentieren. Weitere Details zur Dokumentation der Prahlerei finden Sie im Anhang.
Verwenden Sie die folgenden Befehle, um die Standardintegrationstests auszuführen:
cd ../Org.Quickstart.IntegrationTests/
dotnet restore
dotnet build
dotnet test Für diesen QuickStart verwenden wir drei Sammlungen, Flughafen, Fluggesellschaften und Routen, die Probenflughäfen, Fluggesellschaften und Flugstrecken enthalten. Die Routes -Sammlung verbindet die Flughäfen und Fluggesellschaften wie in der folgenden Abbildung. Wir verwenden diese Verbindungen im QuickStart, um Flughäfen zu generieren, die direkt angeschlossen sind, und Fluggesellschaften, die mit einem Zielflughafen verbunden sind. Beachten Sie, dass dies nur Beispiele sind, um hervorzuheben, wie Sie SQL ++ -Anfragen verwenden können, um den Sammlungen beizutreten.
Wenn Sie den APIs eine andere Entität hinzufügen möchten, sind dies die Schritte, die Sie folgen sollten:
Controllers ähnlich wie die vorhandenen Routen.Org.Quickstart.IntegrationTests ähnlich wie bei AirportTests.cs hinzu.Wenn Sie diesen QuickStart mit einem selbst verwalteten Couchbase-Cluster ausführen, müssen Sie den Reisebeihebahn in Ihrem Cluster laden und die Anmeldeinformationen für den Eimer generieren.
Sie müssen die Verbindungszeichenfolge und die Anmeldeinformationen in der Datei von AppStings.development.json im Quellordner aktualisieren.
HINWEIS: Couchbase muss vor dem Ausführen der ASP.NET -App installiert und ausgeführt werden.
Die Swagger -Dokumentation bietet eine klare Ansicht der API, einschließlich Endpunkten, HTTP -Methoden, Anforderungsparametern und Antwortobjekten.
Klicken Sie auf einen individuellen Endpunkt, um es zu erweitern und detaillierte Informationen anzusehen. Dies umfasst die Beschreibung des Endpunkts, mögliche Antwortstatuscodes und die von ihm akzeptierten Anforderungsparameter.
Sie können eine API ausprobieren, indem Sie neben den Endpunkten auf die Schaltfläche "It Out Out" klicken.
Parameter: Wenn für ein Endpunkt Parameter erforderlich ist, bietet die Swagger -UI Eingabefelds für Sie ein. Dies kann Pfadparameter, Abfragesträge, Header oder den Körper einer Post-/Put -Anforderung enthalten.
Ausführung: Sobald Sie alle erforderlichen Parameter eingegeben haben, können Sie auf die Schaltfläche "Ausführen" klicken, um einen Live -API -Anruf aufzunehmen. Die Swagger UI sendet die Anfrage an die API und zeigt die Antwort direkt in der Dokumentation an. Dies schließt den Antwortcode, die Antwortheader und die Reaktionsbehörde ein.
Swagger dokumentiert die Struktur von Anforderungs- und Antwortkörpern mithilfe von Modellen. Diese Modelle definieren die erwartete Datenstruktur mithilfe von JSON -Schema und sind äußerst hilfreich, um zu verstehen, welche Daten zu senden und zu erwarten sind.
