aspnet quickstart
1.0.0
A menudo, el primer paso que hacen los desarrolladores después de crear su base de datos es crear una API REST que pueda realizar las operaciones Crear, Leer, actualizar y eliminar (CRUD) para esa base de datos. Este repositorio está diseñado para enseñarle y darle un proyecto inicial (en C# usando ASP.NET) para generar dicha API REST. Después de haber instalado un cubo de muestras de viajes en su base de datos, puede ejecutar esta aplicación, que es una API REST con documentación de Swagger para que pueda aprender:
La documentación completa se puede encontrar en el portal de desarrollador de CouchBase.
Si está buscando un arranque rápido con ASP.NET Minimal API, puede encontrarlo en este repositorio.
Para ejecutar este proyecto previamente construido, necesitará:
Caminaremos por los diferentes pasos necesarios para ejecutar la aplicación.
git clone https://github.com/couchbase-examples/aspnet-quickstart.git cd src/Org.Quickstart.API
dotnet restore 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.
Para saber más sobre cómo conectarse a su clúster Capella, siga las instrucciones.
Específicamente, debe hacer lo siguiente:
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 y el nombre del alcance. Se supone que el nombre de usuario predeterminado es Administrator 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.
"Couchbase" : {
"BucketName" : " travel-sample " ,
"ScopeName" : " inventory " ,
"ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
"Username" : " Administrator " ,
"Password" : " P@ssw0rd12 " ,
"IgnoreRemoteCertificateNameMismatch" : true ,
"HttpIgnoreRemoteCertificateMismatch" : true ,
"KvIgnoreRemoteCertificateNameMismatch" : true
}
Nota: La cadena de conexión espera que
couchbases://ocouchbase://Parte.
En este punto, hemos instalado las dependencias, cargamos los datos de la muestra de viaje y configuramos la aplicación con las credenciales. La aplicación ahora está lista y puede ejecutarla.
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-quickstartPuede acceder a la aplicación en http: // localhost: 8080/index.html
Una vez que se inicia la aplicación, puede ver los detalles de la aplicación en los registros.
La aplicación se ejecutará en el puerto 8080 de su máquina local (http: // localhost: 8080/index.html). Encontrará la documentación de Swagger de la API si va a la URL en su navegador. La documentación de Swagger se usa en esta demostración para mostrar los diferentes puntos finales de la API y cómo se pueden invocar. Se pueden encontrar más detalles sobre la documentación de Swagger en el apéndice.
Para ejecutar las pruebas de integración estándar, use los siguientes comandos:
cd ../Org.Quickstart.IntegrationTests/
dotnet restore
dotnet build
dotnet test Para este arranque rápido, utilizamos tres colecciones, aeropuertos, aerolíneas y rutas que contienen aeropuertos de muestra, aerolíneas y rutas de aerolíneas, respectivamente. La colección de rutas conecta los aeropuertos y las aerolíneas como se ve en la figura a continuación. Utilizamos estas conexiones en el comienzo rápido para generar aeropuertos que están directamente conectados y a las aerolíneas que se conectan a un aeropuerto de destino. Tenga en cuenta que estos son solo ejemplos para resaltar cómo puede usar consultas SQL ++ para unirse a las colecciones.
Si desea agregar otra entidad a las API, estos son los pasos a seguir:
Controllers similar a las rutas existentes.Org.Quickstart.IntegrationTests similar a AirportTests.cs .Si está ejecutando este rápido arranque con un clúster de CouchBase autogestionado, debe cargar el cubo de datos de muestras de viaje en su clúster y generar las credenciales para el cubo.
Debe actualizar la cadena de conexión y las credenciales en el archivo appSettings.development.json en la carpeta de origen.
Nota: CouchBase debe instalarse y ejecutar antes de ejecutar la aplicación ASP.NET.
La documentación de Swagger proporciona una vista clara de la API que incluye puntos finales, métodos HTTP, parámetros de solicitud y objetos de respuesta.
Haga clic en un punto final individual para expandirlo y ver información detallada. Esto incluye la descripción del punto final, los posibles códigos de estado de respuesta y los parámetros de solicitud que acepta.
Puede probar una API haciendo clic en el botón "Pruébelo" junto a los puntos finales.
Parámetros: si un punto final requiere parámetros, la interfaz de usuario de Swagger proporciona cuadros de entrada para que pueda completar. Esto podría incluir parámetros de ruta, cadenas de consulta, encabezados o el cuerpo de una solicitud posterior/put.
Ejecución: una vez que haya ingresado todos los parámetros necesarios, puede hacer clic en el botón "Ejecutar" para hacer una llamada API en vivo. Swagger UI enviará la solicitud a la API y mostrará la respuesta directamente en la documentación. Esto incluye el código de respuesta, los encabezados de respuesta y el cuerpo de respuesta.
Swagger documenta la estructura de los cuerpos de solicitud y respuesta utilizando modelos. Estos modelos definen la estructura de datos esperada utilizando el esquema JSON y son extremadamente útiles para comprender qué datos enviar y esperar.
