aspnet quickstart minapi user profile

QuickStart en CouchBase con C# y ASP.NET 6 API mínimo

Construya una API REST con la API mínima C# SDK 3 y ASP.NET de Couchbase y ASP.NET

Este repositorio está diseñado para enseñarle cómo conectarse a un clúster CouchBase para crear, leer, actualizar y eliminar documentos y cómo escribir consultas N1QL parametrizadas simples utilizando el nuevo marco API mínimo ASP.NET.

La documentación completa se puede encontrar en el portal de desarrollador de CouchBase.

Requisitos previos

Para ejecutar este proyecto previamente construido, necesitará:

• Siga las opciones de instalación de CouchBase para instalar la última instancia de servidor de base de datos de CouchBase
• .Net sdk v6+ instalado
• Editor de código instalado (Visual Studio Professional, Visual Studio para Mac o Código Visual Studio)

Instalar dependencias

 cd src/Couchbase.Quickstart
dotnet restore

Nota: Nuget Packages Restauración automática Al construir el proyecto en Visual Studio Professional y Visual Studio para Mac

Paquete Nuget de inyección de dependencia

El SDK de CouchBase para .NET incluye un paquete Nuget llamado Couchbase.Extensions.DependencyInjection que está diseñado para entornos como ASP.NET que requiere una configuración para conectarse a CouchBase y registra automáticamente las interfaces que puede usar en su código para realizar CRUD (create, read, update, delete) operaciones y Queries contra el Database.

Configuración del servidor de bases de datos

Toda la configuración para la comunicación con la base de datos se almacena en el archivo appSettings.development.json. Esto incluye la cadena de conexión, el nombre de usuario, la contraseña, el nombre del cubo, el nombre de Colleciton y el nombre del alcance. Se supone que el nombre de usuario predeterminado es admin y se supone que la contraseña predeterminada es P@$$w0rd12 . Si estos son diferentes en su entorno, deberá cambiarlos antes de ejecutar la aplicación.

Creando el cubo, el nombre de usuario y la contraseña

Con este tutorial, se requiere que se cree un usuario de la base de datos y un cubo antes de ejecutar la aplicación.

Usuarios de Capella

Para los usuarios de Capella, siga las instrucciones que se encuentran en el sitio web de documentación para crear un cubo llamado user_profile . A continuación, siga las instrucciones para configurar las credenciales de la base de datos; admin con una contraseña de P@$$w0rd12 .

A continuación, abra el archivo appsettings.development.json. Localice la propiedad ConnectionString y actualice para que coincida con su nombre de red de área amplia que se encuentra en la pestaña Capella Portal UI Connect. Tenga en cuenta que Capella usa TLS, por lo que la cadena de conexión debe comenzar con CouchBases: //. Esta configuración está diseñada solo para entornos de desarrollo.

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

Los usuarios de Couchbase Capella que no sigan estas instrucciones obtendrán errores de excepción y el portal de Swagger devolverá errores al ejecutar las API.

Instalación local y usuarios de Docker

Para la instalación local y los usuarios de Docker, siga las instrucciones que se encuentran en el sitio web de documentación para crear un cubo llamado user_profile . A continuación, siga las instrucciones para crear un usuario; admin con una contraseña de P@$$w0rd12 . Para este tutorial, asegúrese de que tenga derechos Full Admin para que la aplicación pueda crear colecciones e índices.

A continuación, abra el archivo appsettings.development.json y valida la información de configuración coincide con su configuración.

Nota: Para las instalaciones de Docker y Local Couchbase, CouchBase debe instalarse y ejecutar en Localhost (http://127.0.0.1:8091) antes de ejecutar la aplicación ASP.NET.

Ejecutando la aplicación

En este punto, la aplicación está lista y puede ejecutarla:

 cd src/Couchbase.Quickstart
dotnet run

Una vez que el sitio está en funcionamiento, puede iniciar su navegador e ir a la página de inicio de Swagger para probar las API.

Ejecutando las pruebas

Para ejecutar las pruebas de integración estándar, use los siguientes comandos:

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

Notas de configuración del proyecto

Este proyecto se basó en el proyecto de plantilla ASP.NET estándar y se eliminó la API meteorológica predeterminada.

Conclusión

Configurar una API REST básica en ASP.NET API mínimas con CouchBase es bastante simple. Este proyecto, cuando se ejecuta, creará una colección, un índice para nuestra consulta N1QL parametrizada y muestra las operaciones CRUD básicas necesarias en la mayoría de las aplicaciones.