หน้าแรก>ซอร์สโค้ด ASP>หมวดหมู่อื่นๆ
ดาวน์โหลด

QuickStart ใน CouchBase ด้วย C# และ ASP.NET

REST API โดยใช้ couchbase capella ใน C# และ asp.net

บ่อยครั้งที่นักพัฒนาขั้นตอนแรกทำหลังจากสร้างฐานข้อมูลของพวกเขาคือการสร้าง REST API ที่สามารถดำเนินการสร้างอ่านอัปเดตและลบ (CRUD) สำหรับฐานข้อมูลนั้น repo นี้ออกแบบมาเพื่อสอนคุณและให้โครงการเริ่มต้น (ใน C# โดยใช้ ASP.NET) เพื่อสร้าง REST API ดังกล่าว หลังจากที่คุณติดตั้งถังตัวอย่างการเดินทางในฐานข้อมูลของคุณคุณสามารถเรียกใช้แอปพลิเคชันนี้ซึ่งเป็น REST API พร้อมเอกสารประกอบ Swagger เพื่อให้คุณสามารถเรียนรู้ได้:

  1. วิธีการสร้างอ่านอัปเดตและลบเอกสารโดยใช้การดำเนินการคีย์ค่า (การดำเนินการ KV) การดำเนินการ KV นั้นไม่เหมือนใครสำหรับ CouchBase และมีการค้นหาแบบสอบถามที่รวดเร็ว (คิดว่า microseconds)
  2. วิธีการเขียนแบบสอบถาม SQL ++ แบบง่าย ๆ โดยใช้ถังตัวอย่างการเดินทางในตัว

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

หากคุณกำลังมองหา QuickStart โดยใช้ ASP.NET Minimal API คุณสามารถค้นหาได้ใน repo นี้

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

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

  • คลัสเตอร์ Couchbase Capella พร้อมถังตัวอย่างการเดินทาง
    • ในการเรียกใช้บทช่วยสอนนี้โดยใช้คลัสเตอร์ CouchBase ที่มีการจัดการด้วยตนเองโปรดดูที่ภาคผนวก
  • .NET SDK V6+ ติดตั้ง
    • ตรวจสอบให้แน่ใจว่ารุ่น. NET เข้ากันได้กับ CouchBase SDK
  • ติดตั้ง Code Editor (Visual Studio Professional, Visual Studio Code หรือ Jetbrains Rider)
  • กำลังโหลดถังตัวอย่างการเดินทาง
    • หากตัวอย่างการเดินทางไม่ได้โหลดในคลัสเตอร์ Capella ของคุณคุณสามารถโหลดได้โดยทำตามคำแนะนำสำหรับคลัสเตอร์ Capella ของคุณ:
      • โหลดถังตัวอย่างการเดินทางใน couchbase capella

การตั้งค่าแอป

เราจะเดินผ่านขั้นตอนต่าง ๆ ที่จำเป็นเพื่อให้แอปพลิเคชันทำงาน

การโคลนนิ่ง repo 

git clone https://github.com/couchbase-examples/aspnet-quickstart.git

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

 cd src/Org.Quickstart.API
dotnet restore

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

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

การกำหนดค่าฐานข้อมูลการตั้งค่า

หากต้องการทราบข้อมูลเพิ่มเติมเกี่ยวกับการเชื่อมต่อกับคลัสเตอร์ Capella ของคุณโปรดทำตามคำแนะนำ

โดยเฉพาะคุณต้องทำสิ่งต่อไปนี้:

  • สร้างข้อมูลรับรองฐานข้อมูลเพื่อเข้าถึงถังตัวอย่างการเดินทาง (อ่านและเขียน) ที่ใช้ในแอปพลิเคชัน
  • อนุญาตให้เข้าถึงคลัสเตอร์จาก IP ที่แอปพลิเคชันกำลังทำงานอยู่

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

  "Couchbase" : {
    "BucketName" : " travel-sample " ,
    "ScopeName" : " inventory " ,
    "ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
    "Username" : " Administrator " ,
    "Password" : " P@ssw0rd12 " ,
    "IgnoreRemoteCertificateNameMismatch" : true ,
    "HttpIgnoreRemoteCertificateMismatch" : true ,
    "KvIgnoreRemoteCertificateNameMismatch" : true
  }

หมายเหตุ: สตริงการเชื่อมต่อคาดว่าจะใช้ couchbases:// หรือ couchbase:// ส่วน

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

โดยตรงบนเครื่อง

ณ จุดนี้เราได้ติดตั้งการพึ่งพาโหลดข้อมูลตัวอย่างการเดินทางและกำหนดค่าแอปพลิเคชันด้วยข้อมูลรับรอง ขณะนี้แอปพลิเคชันพร้อมแล้วและคุณสามารถเรียกใช้งานได้ 

 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-quickstart

คุณสามารถเข้าถึงแอปพลิเคชันได้ที่ http: // localhost: 8080/index.html

ตรวจสอบแอปพลิเคชัน

เมื่อแอปพลิเคชันเริ่มต้นคุณสามารถดูรายละเอียดของแอปพลิเคชันบนบันทึก

การเริ่มต้นแอปพลิเคชัน

แอปพลิเคชันจะทำงานบนพอร์ต 8080 ของเครื่องในพื้นที่ของคุณ (http: // localhost: 8080/index.html) คุณจะพบเอกสาร Swagger ของ API หากคุณไปที่ URL ในเบราว์เซอร์ของคุณ เอกสาร Swagger ใช้ในการสาธิตนี้เพื่อแสดงจุดสิ้นสุด API ที่แตกต่างกันและวิธีการเรียกใช้ รายละเอียดเพิ่มเติมเกี่ยวกับเอกสาร Swagger สามารถพบได้ในภาคผนวก

เอกสาร Swagger

การทดสอบกำลังดำเนินการ

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

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

ภาคผนวก

รูปแบบข้อมูล

สำหรับ quickstart นี้เราใช้คอลเล็กชั่นสามสนามบินสายการบินและเส้นทางที่มีสนามบินตัวอย่างสายการบินและเส้นทางสายการบินตามลำดับ คอลเลกชันเส้นทางเชื่อมต่อสนามบินและสายการบินตามที่เห็นในรูปด้านล่าง เราใช้การเชื่อมต่อเหล่านี้ใน QuickStart เพื่อสร้างสนามบินที่เชื่อมต่อโดยตรงและสายการบินที่เชื่อมต่อกับสนามบินปลายทาง โปรดทราบว่านี่เป็นเพียงตัวอย่างเพื่อเน้นวิธีที่คุณสามารถใช้แบบสอบถาม SQL ++ เพื่อเข้าร่วมคอลเลกชัน

รูปแบบข้อมูลตัวอย่างการเดินทาง

ขยาย API โดยการเพิ่มเอนทิตีใหม่

หากคุณต้องการเพิ่มเอนทิตีอื่นไปยัง APIs นี่คือขั้นตอนที่ต้องปฏิบัติตาม:

  • สร้างเอนทิตีใหม่ (คอลเลกชัน) ในถัง CouchBase คุณสามารถสร้างคอลเลกชันโดยใช้ SDK หรือผ่านอินเทอร์เฟซเซิร์ฟเวอร์ CouchBase
  • กำหนดเส้นทางในไฟล์ภายในโฟลเดอร์ Controllers คล้ายกับเส้นทางที่มีอยู่
  • เพิ่มการทดสอบสำหรับเส้นทางใหม่ในไฟล์ใหม่ในโฟลเดอร์ Org.Quickstart.IntegrationTests คล้ายกับ AirportTests.cs tests.cs

เรียกใช้คลัสเตอร์ couchbase ที่จัดการด้วยตนเอง

หากคุณกำลังใช้งานเร็วนี้ด้วยคลัสเตอร์ couchbase ที่มีการจัดการด้วยตนเองคุณต้องโหลดถังข้อมูลตัวอย่างการเดินทางในคลัสเตอร์ของคุณและสร้างข้อมูลรับรองสำหรับถัง

คุณต้องอัปเดตสตริงการเชื่อมต่อและข้อมูลรับรองในไฟล์ appsettings.development.json ในโฟลเดอร์ต้นทาง

หมายเหตุ: ต้องติดตั้ง CouchBase และเรียกใช้ก่อนที่จะเรียกใช้แอพ ASP.NET

เอกสาร Swagger

เอกสาร Swagger ให้มุมมองที่ชัดเจนของ API รวมถึงจุดสิ้นสุดวิธี HTTP พารามิเตอร์การร้องขอและวัตถุตอบสนอง

คลิกที่จุดสิ้นสุดแต่ละจุดเพื่อขยายและดูข้อมูลโดยละเอียด ซึ่งรวมถึงคำอธิบายของจุดสิ้นสุดรหัสสถานะการตอบกลับที่เป็นไปได้และพารามิเตอร์คำขอที่ยอมรับ

ลองใช้ API

คุณสามารถลองใช้ API ได้โดยคลิกที่ปุ่ม "ลองใช้" ถัดจากจุดสิ้นสุด

  • พารามิเตอร์: หากจุดสิ้นสุดต้องใช้พารามิเตอร์ Swagger UI จะให้กล่องอินพุตเพื่อให้คุณกรอกข้อมูลซึ่งอาจรวมถึงพารามิเตอร์เส้นทาง, สตริงการสืบค้น, ส่วนหัวหรือร่างกายของคำขอโพสต์/ใส่

  • การดำเนินการ: เมื่อคุณป้อนพารามิเตอร์ที่จำเป็นทั้งหมดแล้วคุณสามารถคลิกปุ่ม "ดำเนินการ" เพื่อทำการโทรสด API Swagger UI จะส่งคำขอไปยัง API และแสดงการตอบกลับโดยตรงในเอกสารประกอบ ซึ่งรวมถึงรหัสตอบกลับส่วนหัวการตอบสนองและการตอบสนอง

แบบจำลอง

Swagger จัดทำเอกสารโครงสร้างของการร้องขอและการตอบสนองโดยใช้แบบจำลอง โมเดลเหล่านี้กำหนดโครงสร้างข้อมูลที่คาดหวังโดยใช้ JSON Schema และมีประโยชน์อย่างมากในการทำความเข้าใจว่าข้อมูลใดที่จะส่งและคาดหวัง

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด