aspnet quickstart minapi user profile

QuickStart ใน CouchBase ด้วย C# และ ASP.NET 6 API ขั้นต่ำ

สร้าง REST API ด้วย CouchBase's C# SDK 3 และ ASP.NET API ขั้นต่ำ

repo นี้ได้รับการออกแบบมาเพื่อสอนวิธีการเชื่อมต่อกับคลัสเตอร์ CouchBase เพื่อสร้างอ่านอัปเดตและลบเอกสารและวิธีการเขียนแบบสอบถาม N1QL แบบ parametrized แบบง่ายโดยใช้เฟรมเวิร์กขั้นต่ำ ASP.NET ใหม่

เอกสารฉบับเต็มสามารถพบได้ในพอร์ทัลนักพัฒนา CouchBase

ข้อกำหนดเบื้องต้น

ในการเรียกใช้โครงการ prebuilt นี้คุณจะต้อง:

• ติดตามตัวเลือกการติดตั้ง CouchBase สำหรับการติดตั้งอินสแตนซ์เซิร์ฟเวอร์ฐานข้อมูล CouchBase ล่าสุด
• .NET SDK V6+ ติดตั้ง
• ติดตั้ง Code Editor (Visual Studio Professional, Visual Studio สำหรับ Mac หรือ Visual Studio Code)

ติดตั้งการพึ่งพา

 cd src/Couchbase.Quickstart
dotnet restore

หมายเหตุ: Nuget Packages กู้คืนอัตโนมัติเมื่อสร้างโครงการใน Visual Studio Professional และ Visual Studio สำหรับ Mac

แพ็คเกจการพึ่งพา

CouchBase SDK สำหรับ. NET รวมถึงแพ็คเกจ NUGET ที่เรียกว่า Couchbase.Extensions.DependencyInjection การฉีดวัคซีนซึ่งออกแบบมาสำหรับสภาพแวดล้อมเช่น asp.net ที่ใช้ในการกำหนดค่าเพื่อเชื่อมต่อกับ couchbase และลงทะเบียนอินเทอร์ CRUD (create, read, update, delete) โดยอัตโนมัติที่คุณสามารถใช้ในรหัสของคุณ

การกำหนดค่าเซิร์ฟเวอร์ฐานข้อมูล

การกำหนดค่าทั้งหมดสำหรับการสื่อสารกับฐานข้อมูลจะถูกเก็บไว้ในไฟล์ appsettings.development.json ซึ่งรวมถึงสตริงการเชื่อมต่อชื่อผู้ใช้รหัสผ่านชื่อถังชื่อ Colleciton และชื่อขอบเขต ชื่อผู้ใช้เริ่มต้นจะถือว่าเป็น admin และรหัสผ่านเริ่มต้นจะถือว่าเป็น P@$$w0rd12 หากสิ่งเหล่านี้แตกต่างกันในสภาพแวดล้อมของคุณคุณจะต้องเปลี่ยนพวกเขาก่อนเรียกใช้แอปพลิเคชัน

การสร้างถังชื่อผู้ใช้และรหัสผ่าน

ด้วยบทช่วยสอนนี้จำเป็นต้องมีการสร้างผู้ใช้ฐานข้อมูลและถังก่อนที่จะเรียกใช้แอปพลิเคชัน

ผู้ใช้ Capella

สำหรับผู้ใช้ Capella ให้ทำตามคำแนะนำที่พบในเว็บไซต์เอกสารสำหรับการสร้างถังที่เรียกว่า user_profile ถัดไปทำตามคำแนะนำสำหรับการกำหนดค่าข้อมูลรับรองฐานข้อมูล ตั้งชื่อ admin ด้วยรหัสผ่านของ P@$$w0rd12

ถัดไปเปิดไฟล์ appsettings.development.json ค้นหาคุณสมบัติ ConnectionString และอัปเดตเพื่อให้ตรงกับชื่อเครือข่ายพื้นที่กว้างของคุณที่พบในแท็บ Capella Portal UI Connect โปรดทราบว่า Capella ใช้ TLS ดังนั้นสตริงการเชื่อมต่อจะต้องเริ่มต้นด้วย couchbases: // การกำหนดค่านี้ออกแบบมาสำหรับสภาพแวดล้อมการพัฒนาเท่านั้น

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

ผู้ใช้ Couchbase Capella ที่ไม่ปฏิบัติตามคำแนะนำเหล่านี้จะได้รับข้อผิดพลาดข้อยกเว้นและพอร์ทัล Swagger จะส่งคืนข้อผิดพลาดเมื่อเรียกใช้ APIs

ผู้ใช้การติดตั้งในพื้นที่และผู้ใช้ Docker

สำหรับผู้ใช้การติดตั้งในท้องถิ่นและผู้ใช้ Docker ให้ทำตามคำแนะนำที่พบในเว็บไซต์เอกสารสำหรับการสร้างถังที่เรียกว่า user_profile ถัดไปทำตามคำแนะนำสำหรับการสร้างผู้ใช้ ตั้งชื่อ admin ด้วยรหัสผ่านของ P@$$w0rd12 สำหรับบทช่วยสอนนี้ตรวจสอบให้แน่ใจว่ามีสิทธิ์ Full Admin เพื่อให้แอปพลิเคชันสามารถสร้างคอลเลกชันและดัชนี

ถัดไปเปิดไฟล์ appsettings.development.json และตรวจสอบข้อมูลการกำหนดค่าตรงกับการตั้งค่าของคุณ

หมายเหตุ: สำหรับการติดตั้ง Docker และ Local Couchbase ต้องติดตั้ง CouchBase และทำงานบน LocalHost (http://127.0.0.1:8091) ก่อนที่จะเรียกใช้แอพ ASP.NET

การรันแอปพลิเคชัน

ณ จุดนี้แอปพลิเคชันพร้อมแล้วและคุณสามารถเรียกใช้ได้:

 cd src/Couchbase.Quickstart
dotnet run

เมื่อไซต์เปิดใช้งานแล้วคุณสามารถเปิดเบราว์เซอร์ของคุณและไปที่หน้าเริ่มต้น Swagger เพื่อทดสอบ APIs

รันการทดสอบ

ในการเรียกใช้การทดสอบการรวมมาตรฐานให้ใช้คำสั่งต่อไปนี้:

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

บันทึกการตั้งค่าโครงการ

โครงการนี้ขึ้นอยู่กับโครงการเทมเพลต ASP.NET มาตรฐานและ API สภาพอากาศเริ่มต้นถูกลบออก

บทสรุป

การตั้งค่า REST API พื้นฐานใน API ขั้นต่ำ ASP.NET กับ CouchBase นั้นค่อนข้างง่าย โครงการนี้เมื่อ RUN จะสร้างคอลเลกชันดัชนีสำหรับการสืบค้น N1QL พารามิเตอร์ของเราและแสดงการดำเนินการ CRUD พื้นฐานที่จำเป็นในแอปพลิเคชันส่วนใหญ่