aspnet quickstart minapi user profile

QuickStart dans Couchbase avec C # et ASP.NET 6 API minimum

Construisez une API REST avec API minimum C # SDK 3 et ASP.NET de Couchbase

Ce dépôt est conçu pour vous apprendre à vous connecter à un cluster CouchBase pour créer, lire, mettre à jour et supprimer des documents et comment rédiger des requêtes N1QL paramétrées simples à l'aide du nouveau cadre API minimum ASP.NET.

Une documentation complète peut être trouvée sur le portail des développeurs Couchbase.

Condition préalable

Pour exécuter ce projet prédéfini, vous aurez besoin:

• Suivez les options d'installation de Couchbase pour installer l'instance de serveur de base de données CouchBase le plus
• .NET SDK V6 + installé
• Éditeur de code installé (Visual Studio Professional, Visual Studio pour Mac ou Visual Studio Code)

Installer des dépendances

 cd src/Couchbase.Quickstart
dotnet restore

Remarque: Nuget Packages Auto Restore lors de la construction du projet dans Visual Studio Professional et Visual Studio pour Mac

Package Nuget de dépendance

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.

Configuration du serveur de base de données

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 de seau, le nom de collection et le nom de la portée. Le nom d'utilisateur par défaut est supposé être admin 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.

Création du seau, du nom d'utilisateur et du mot de passe

Avec ce tutoriel, il est nécessaire que un utilisateur et un godet de base de données soient créés avant d'exécuter l'application.

Utilisateurs de Capella

Pour les utilisateurs de Capella, suivez les instructions trouvées sur le site Web de documentation pour créer un seau appelé user_profile . Ensuite, suivez les instructions pour configurer les informations d'identification de la base de données; Nommez l' admin avec un mot de passe de P@$$w0rd12 .

Ensuite, ouvrez le fichier AppSettings.development.json. Localisez la propriété ConnectionString et mettez-la à mettre à jour pour correspondre à votre nom de réseau large dans l'onglet Connect Connect de Capella Portal UI. Notez que Capella utilise TLS afin que la chaîne de connexion doit démarrer avec Couchbases: //. Cette configuration est conçue uniquement pour les environnements de développement.

  "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
  }

Les utilisateurs de Couchbase Capella qui ne suivent pas ces instructions obtiendront des erreurs d'exception et le portail Swagger renvoie des erreurs lors de l'exécution des API.

Installation locale et utilisateurs de Docker

Pour les utilisateurs d'installation locale et Docker, suivez les instructions trouvées sur le site Web de documentation pour créer un seau appelé user_profile . Ensuite, suivez les instructions pour la création d'un utilisateur; Nommez l' admin avec un mot de passe de P@$$w0rd12 . Pour ce tutoriel, assurez-vous qu'il a des droits Full Admin afin que l'application puisse créer des collections et des index.

Ensuite, ouvrez le fichier AppSettings.development.json et validez les informations de configuration correspond à votre configuration.

Remarque: Pour les installations Docker et CouchBase locales, CouchBase doit être installé et en cours d'exécution sur localhost (http://127.0.0.1:8091) avant d'exécuter l'application ASP.NET.

Exécution de l'application

À ce stade, l'application est prête et vous pouvez l'exécuter:

 cd src/Couchbase.Quickstart
dotnet run

Une fois le site opérationnel, vous pouvez lancer votre navigateur et vous rendre sur la page Swagger Start pour tester les API.

Exécuter les tests

Pour exécuter les tests d'intégration standard, utilisez les commandes suivantes:

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

Notes de configuration du projet

Ce projet était basé sur le projet de modèle ASP.NET standard et l'API météo par défaut a été supprimée.

Conclusion

La configuration d'une API REST de base dans ASP.NET API Minimum avec CouchBase est assez simple. Ce projet lors de l'exécution créera une collection, un index pour notre requête N1QL paramétrée et présente les opérations CRUD de base nécessaires dans la plupart des applications.