aspnet quickstart

QuickStart di Couchbase dengan C# dan Asp.net

REST API Menggunakan COUCHBASE CAPELLA DI C# dan ASP.NET

Seringkali, langkah pertama yang dilakukan pengembang setelah membuat basis data mereka adalah membuat API REST yang dapat melakukan operasi membuat, membaca, memperbarui, dan menghapus (CRUD) untuk database tersebut. Repo ini dirancang untuk mengajari Anda dan memberi Anda proyek starter (dalam C# menggunakan ASP.NET) untuk menghasilkan API REST tersebut. Setelah Anda menginstal ember sampel perjalanan di database Anda, Anda dapat menjalankan aplikasi ini yang merupakan API REST dengan dokumentasi Swagger sehingga Anda dapat belajar:

1. Cara Membuat, Membaca, Perbarui, dan Hapus Dokumen Menggunakan Operasi Nilai Kunci (Operasi KV). Operasi KV unik untuk couchbase dan memberikan pertanyaan super cepat (pikirkan mikrodetik).
2. Cara menulis kueri SQL ++ parametrized sederhana menggunakan ember sampel perjalanan bawaan.

Dokumentasi lengkap dapat ditemukan di portal pengembang sofa.

Jika Anda mencari QuickStart menggunakan API minimal ASP.NET, Anda dapat menemukannya di repo ini.

Prasyarat

Untuk menjalankan proyek prebuilt ini, Anda akan membutuhkan:

• Couchbase capella cluster dengan ember sampel perjalanan dimuat.
  • Untuk menjalankan tutorial ini menggunakan cluster Couchbase yang dikelola sendiri, silakan merujuk ke Lampiran.
• .Net SDK V6+ diinstal.
  • Pastikan bahwa versi .net kompatibel dengan sofa SDK.
• Editor kode yang diinstal (Visual Studio Professional, Visual Studio Code, atau JetBrains Rider)
• Memuat ember sampel perjalanan
  • Jika sampel perjalanan tidak dimuat di kluster Capella Anda, Anda dapat memuatnya dengan mengikuti instruksi untuk cluster Capella Anda:
    • Muat ember sampel perjalanan di capella couchbase

Pengaturan Aplikasi

Kami akan berjalan melalui berbagai langkah yang diperlukan untuk menjalankan aplikasi.

Kloning repo

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

Instal dependensi

 cd src/Org.Quickstart.API
dotnet restore

Paket Nuget Injeksi Ketergantungan

The Couchbase SDK for .NET includes a nuget package called Couchbase.Extensions.DependencyInjection which is designed for environments like ASP.NET that takes in a configuration to connect to Couchbase and automatically registers interfaces that you can use in your code to perform full CRUD (create, read, update, delete) operations and queries against the database.

Pengaturan Konfigurasi Basis Data

Untuk mengetahui lebih banyak tentang menghubungkan ke cluster Capella Anda, silakan ikuti instruksi.

Secara khusus, Anda perlu melakukan hal berikut:

• Buat kredensial basis data untuk mengakses ember sampel perjalanan (baca dan tulis) yang digunakan dalam aplikasi.
• Izinkan akses ke cluster dari IP tempat aplikasi berjalan.

Semua konfigurasi untuk komunikasi dengan database disimpan di file appsettings.development.json. Ini termasuk string koneksi, nama pengguna, kata sandi, nama ember dan nama lingkup. Nama pengguna default diasumsikan sebagai Administrator dan kata sandi default diasumsikan P@$$w0rd12 . Jika ini berbeda di lingkungan Anda, Anda perlu mengubahnya sebelum menjalankan aplikasi.

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

Catatan: String koneksi mengharapkan couchbases:// atau couchbase:// bagian.

Menjalankan aplikasi

Langsung di mesin

Pada titik ini, kami telah menginstal dependensi, memuat data sampel perjalanan dan mengkonfigurasi aplikasi dengan kredensial. Aplikasi sekarang siap dan Anda dapat menjalankannya.

 cd src/Org.Quickstart.API
dotnet run

Menggunakan Docker

• Bangun gambar Docker

 cd aspnet-quickstart
docker build -t couchbase-aspnet-quickstart . 

• Jalankan gambar Docker

 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

Anda dapat mengakses aplikasi di http: // localhost: 8080/index.html

Memverifikasi aplikasi

Setelah aplikasi dimulai, Anda dapat melihat detail aplikasi pada log.

Aplikasi ini akan berjalan pada port 8080 dari mesin lokal Anda (http: // localhost: 8080/index.html). Anda akan menemukan dokumentasi API yang angkuh jika Anda pergi ke URL di browser Anda. Dokumentasi Swagger digunakan dalam demo ini untuk menampilkan titik akhir API yang berbeda dan bagaimana mereka dapat dipanggil. Rincian lebih lanjut tentang dokumentasi Swagger dapat ditemukan di Lampiran.

Menjalankan tes

Untuk menjalankan tes integrasi standar, gunakan perintah berikut:

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

Lampiran

Model Data

Untuk QuickStart ini, kami menggunakan tiga koleksi, bandara, maskapai dan rute yang masing -masing berisi bandara sampel, maskapai penerbangan, dan rute maskapai. Koleksi rute menghubungkan bandara dan maskapai penerbangan seperti yang terlihat pada gambar di bawah ini. Kami menggunakan koneksi ini di QuickStart untuk menghasilkan bandara yang terhubung langsung dan maskapai yang terhubung ke bandara tujuan. Perhatikan bahwa ini hanya contoh untuk menyoroti bagaimana Anda dapat menggunakan kueri SQL ++ untuk bergabung dengan koleksi.

Memperluas API dengan menambahkan entitas baru

Jika Anda ingin menambahkan entitas lain ke API, ini adalah langkah -langkah yang harus diikuti:

• Buat entitas baru (koleksi) di ember sofa. Anda dapat membuat koleksi menggunakan SDK atau melalui antarmuka server Couchbase.
• Tentukan rute dalam file di dalam folder Controllers yang mirip dengan rute yang ada.
• Tambahkan tes untuk rute baru dalam file baru di folder Org.Quickstart.IntegrationTests mirip dengan AirportTests.cs .

Menjalankan cluster souchbase yang dikelola sendiri

Jika Anda menjalankan QuickStart ini dengan cluster Couchbase yang dikelola sendiri, Anda perlu memuat ember data sampel perjalanan di cluster Anda dan menghasilkan kredensial untuk ember.

Anda perlu memperbarui string koneksi dan kredensial di file appsettings.development.json di folder sumber.

Catatan: Couchbase harus diinstal dan berjalan sebelum menjalankan aplikasi ASP.NET.

Dokumentasi Swagger

Dokumentasi Swagger memberikan tampilan API yang jelas termasuk titik akhir, metode HTTP, parameter permintaan, dan objek respons.

Klik pada titik akhir individual untuk memperluasnya dan lihat informasi terperinci. Ini termasuk deskripsi titik akhir, kode status respons yang mungkin, dan parameter permintaan yang diterimanya.

Mencoba API

Anda dapat mencoba API dengan mengklik tombol "Coba out out" di sebelah titik akhir.

• Parameter: Jika titik akhir membutuhkan parameter, Swagger UI menyediakan kotak input untuk Anda isi. Ini dapat mencakup parameter jalur, string kueri, header, atau badan permintaan pos/put.

• Eksekusi: Setelah Anda memasukkan semua parameter yang diperlukan, Anda dapat mengklik tombol "Jalankan" untuk melakukan panggilan API langsung. Swagger UI akan mengirim permintaan ke API dan menampilkan respons secara langsung dalam dokumentasi. Ini termasuk kode respons, header respons, dan badan respons.

Model

Swagger mendokumentasikan struktur Badan Permintaan dan Respons menggunakan model. Model -model ini menentukan struktur data yang diharapkan menggunakan skema JSON dan sangat membantu dalam memahami data apa yang akan dikirim dan diharapkan.