aspnet quickstart
1.0.0
Souvent, les développeurs de la première étape font après la création de leur base de données consiste à créer une API REST qui peut effectuer des opérations Créer, lire, mettre à jour et supprimer (CRUD) pour cette base de données. Ce dépôt est conçu pour vous enseigner et vous donner un projet de démarrage (en C # en utilisant ASP.NET) pour générer une telle API REST. Après avoir installé un seau de voyage dans votre base de données, vous pouvez exécuter cette application qui est une API REST avec la documentation de Swagger afin que vous puissiez apprendre:
Une documentation complète peut être trouvée sur le portail des développeurs Couchbase.
Si vous recherchez unckstart en utilisant ASP.NET API Minimal, vous pouvez le trouver dans ce référentiel.
Pour exécuter ce projet prédéfini, vous aurez besoin:
Nous parcourons les différentes étapes nécessaires pour faire fonctionner l'application.
git clone https://github.com/couchbase-examples/aspnet-quickstart.git cd src/Org.Quickstart.API
dotnet restore Le SDK Couchbase pour .NET comprend un package NuGet appelé Couchbase.Extensions.DependencyInjection qui est conçu pour des environnements tels que ASP.NET qui prend une configuration pour se connecter à Couchbase et enregistre automatiquement les interfaces que vous pouvez utiliser dans votre code pour effectuer des opérations CRUD (create, read, update, delete) contre la données complète.
Pour en savoir plus sur la connexion à votre cluster Capella, veuillez suivre les instructions.
Plus précisément, vous devez faire ce qui suit:
Toute la configuration de la communication avec la base de données est stockée dans le fichier AppSettings.development.json. Cela inclut la chaîne de connexion, le nom d'utilisateur, le mot de passe, le nom du seau et le nom de la portée. Le nom d'utilisateur par défaut est supposé être Administrator et le mot de passe par défaut est supposé être P@$$w0rd12 . Si ceux-ci sont différents dans votre environnement, vous devrez les modifier avant d'exécuter l'application.
"Couchbase" : {
"BucketName" : " travel-sample " ,
"ScopeName" : " inventory " ,
"ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
"Username" : " Administrator " ,
"Password" : " P@ssw0rd12 " ,
"IgnoreRemoteCertificateNameMismatch" : true ,
"HttpIgnoreRemoteCertificateMismatch" : true ,
"KvIgnoreRemoteCertificateNameMismatch" : true
}
Remarque: La chaîne de connexion s'attend à ce que les
couchbases://oucouchbase://pièce.
À ce stade, nous avons installé les dépendances, chargé les données de l'échantillon de voyage et configuré l'application avec les informations d'identification. L'application est maintenant prête et vous pouvez l'exécuter.
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-quickstartVous pouvez accéder à l'application sur http: // localhost: 8080 / index.html
Une fois l'application démontr, vous pouvez voir les détails de l'application sur les journaux.
L'application s'exécutera sur le port 8080 de votre machine locale (http: // localhost: 8080 / index.html). Vous trouverez la documentation Swagger de l'API si vous allez à l'URL de votre navigateur. La documentation de Swagger est utilisée dans cette démo pour présenter les différents points finaux de l'API et comment ils peuvent être invoqués. Plus de détails sur la documentation Swagger peuvent être trouvés dans l'annexe.
Pour exécuter les tests d'intégration standard, utilisez les commandes suivantes:
cd ../Org.Quickstart.IntegrationTests/
dotnet restore
dotnet build
dotnet test Pour ce Quickstart, nous utilisons trois collections, aéroport, compagnie aérienne et itinéraires qui contiennent respectivement des aéroports, des compagnies aériennes et des compagnies aériennes. La collection Routes relie les aéroports et les compagnies aériennes comme le montre la figure ci-dessous. Nous utilisons ces connexions dans le startart pour générer des aéroports qui sont directement connectés et les compagnies aériennes se connectant à un aéroport de destination. Notez que ce ne sont que des exemples pour souligner comment vous pouvez utiliser les requêtes SQL ++ pour rejoindre les collections.
Si vous souhaitez ajouter une autre entité aux API, ce sont les étapes à suivre:
Controllers similaires aux routes existantes.Org.Quickstart.IntegrationTests similaire à AirportTests.cs .Si vous exécutez ce QuickStart avec un cluster Couchbase auto-géré, vous devez charger le seau de données de voyage dans votre cluster et générer les informations d'identification pour le seau.
Vous devez mettre à jour la chaîne de connexion et les informations d'identification dans le fichier AppSettings.development.json dans le dossier source.
Remarque: CouchBase doit être installé et en cours d'exécution avant d'exécuter l'application ASP.NET.
La documentation Swagger fournit une vue claire de l'API, y compris les points de terminaison, les méthodes HTTP, les paramètres de demande et les objets de réponse.
Cliquez sur un point de terminaison individuel pour le développer et voir des informations détaillées. Cela inclut la description du point de terminaison, les codes d'état de réponse possibles et les paramètres de demande qu'il accepte.
Vous pouvez essayer une API en cliquant sur le bouton "Essayez-le" à côté des points de terminaison.
Paramètres: Si un point de terminaison nécessite des paramètres, Swagger UI fournit des boîtes d'entrée à remplir.
Exécution: Une fois que vous avez saisi tous les paramètres nécessaires, vous pouvez cliquer sur le bouton "Exécuter" pour passer un appel API en direct. L'interface utilisateur de Swagger enverra la demande à l'API et affichera la réponse directement dans la documentation. Cela inclut le code de réponse, les en-têtes de réponse et le corps de réponse.
Swagger documente la structure des corps de demande et de réponse à l'aide de modèles. Ces modèles définissent la structure de données attendue à l'aide du schéma JSON et sont extrêmement utiles pour comprendre les données à envoyer et à attendre.
