ContosoPizzaWebApiDemo
1.0.0
Demo API Web sederhana dengan dokumentasi Swagger, penanganan kesalahan khusus, tes unit, JSONPatch, dan tester httpclient. Fitur video YouTube bergaya tutorial untuk beberapa topik.
Tujuan dari proyek GitHub ini adalah untuk mendemonstrasikan aplikasi API web CRUD sederhana dengan tutorial tambahan (termasuk video YouTube) dan referensi termasuk kesombongan, pengujian unit, JSONPATCH, penanganan dan tampilan kesalahan khusus, penguji klien, dll.
Solusi Visual Studio memiliki tiga proyek: contosopizza (Web API), contosopizza.tests (unit tes), dan webapiclient (aplikasi konsol httpclient sederhana)
Kelas pengontrol, model, dan layanan dengan ringkasan anggota mereka dari proyek API Web Contosopizza ditampilkan di bawah ini.
Ini adalah API Web sederhana yang mengikuti pola CRUD (Buat, Baca, Perbarui, dan Hapus) standar. Gambar demo dari operasi API ditunjukkan di bawah ini berdasarkan kategori.
Berikut adalah beberapa tangkapan layar yang menunjukkan demo Web API JSONPATCH.
Ini referensi kode.
[
{
"value": "ModifiedPizza",
"path": "/name",
"op": "replace"
}
]
Ini adalah video referensi tutorial yang hebat jika Anda ingin mempelajari lebih lanjut tentang pengaturan, menginstal, dan menggunakan JSONPatch untuk proyek API Web Anda.
Memperbarui data dengan JSONPATCH | Serial pemula ke API Web
JSONPATCH di ASP.NET Core Web API
Proyek tutorial dan demo ini akan menunjukkan cara mengatur, mengkonfigurasi, dan mengkode penangan kesalahan khusus sederhana untuk proyek API Web Contoso Pizza.
Pengembang harus merencanakan kesalahan yang tidak ditangani dalam kode. Proyek API Web Contoso Pizza menunjukkan cara melakukan ini. Dalam demo, titik akhir dibuat yang selalu melempar pengecualian yang tidak ditangani. Proyek ini memiliki pengontrol kesalahan khusus yang menangani dan mencatat pengecualian sebelum mengembalikan objek model masalah standar kepada pengguna. Pengontrol kesalahan ditentukan dalam konfigurasi program untuk merutekan ke pengontrol kesalahan khusus saat tidak berjalan di lingkungan pengembangan. Lingkungan pengembangan ditentukan di bawah pengaturan profil peluncuran Debug, dengan nilai default adalah produksi kecuali ditentukan lain.
Untuk melihat perbedaan dalam tampilan kesalahan antara pengembangan dan produksi, pertama -tama jalankan API dalam mode pengembangan. Uji titik akhir yang selalu memicu pengecualian yang tidak ditangani. Di UI Swagger, Anda dapat melihat respons dan detail pengecualian. Jendela browser memiliki tampilan pengembang yang terpisah dan elegan dari hasil kesalahan.
Untuk menjalankan API dalam mode produksi, lepaskan variabel lingkungan atau atur secara manual nilai ke produksi. Karena Swagger UI tidak berjalan dalam mode produksi, Anda perlu menguji titik akhir API secara manual dengan URL. Hasil akhir untuk pengguna adalah kesalahan umum dengan pengidentifikasi. Seorang pengguna akan membuat tiket masalah dengan informasi ini. Perusahaan kemudian dapat menyelesaikan pemecahan masalah terperinci yang mencocokkan pengidentifikasi kesalahan dengan pencatatan internal yang lebih rinci.
Proyek tutorial dan demo ini akan menunjukkan kepada Anda cara menambah, mengatur, mengkonfigurasi, dan memverifikasi dokumentasi kesombongan ke proyek pengembang WebAPI Anda. Hasil akhir ada dalam repo kode ini.
Swashbuckle dan Swagger adalah dua alat populer yang digunakan untuk menghasilkan dokumentasi pengembang untuk API Web. Swashbuckle adalah paket yang dapat ditambahkan ke proyek API Web Core ASP.NET untuk mengintegrasikan UI Swagger. Ini memiliki tiga komponen utama: swashbuckle.aspnetcore.swagger, yang merupakan model objek Swagger dan middleware untuk mengekspos objek dokumen Swagger sebagai titik akhir JSON; Swashbuckle.aspnetcore.swaggengen, yang merupakan generator kesombongan yang membangun objek dokumen Swagger langsung dari rute, pengontrol, dan model Anda; dan swashbuckle.aspnetcore.swaggerui, yang merupakan versi tertanam dari alat UI Swagger. Ini menginterpretasikan Swagger Json untuk membangun pengalaman yang kaya dan dapat disesuaikan untuk menggambarkan fungsionalitas Web API. Swagger (OpenAPI) adalah spesifikasi bahasa-agnostik untuk menggambarkan API REST. Ini memungkinkan komputer dan manusia untuk memahami kemampuan API REST tanpa akses langsung ke kode sumber. Tujuan utamanya adalah untuk meminimalkan jumlah pekerjaan yang diperlukan untuk menghubungkan layanan yang dipisahkan. ¹³⁴
Proyek tutorial dan demo ini akan menunjukkan cara mengatur, mengkonfigurasi, dan mengkodekan httpClient sederhana untuk proyek API Web Contoso Pizza.
Dalam video YouTube ini, kami akan belajar cara membuat proyek aplikasi konsol sederhana yang terhubung ke API Web dan mengujinya. Video tersebut mencakup demo pendek dari proyek yang menjalankan dan mengeluarkan hasil dari API. Kami akan mendapatkan file OpenAPI dengan pertama -tama menjalankan WebAPI kami secara lokal untuk menunjukkan UI Swagger. File JSON untuk API Web kami dapat diunduh dan disimpan ke direktori proyek kami. Ada video lain dalam seri playlist yang menunjukkan cara mengatur dan mengkonfigurasi dokumentasi Swagger. Langkah selanjutnya adalah menambahkan proyek aplikasi konsol baru ke solusi kami. Ini akan menjadi aplikasi HTTPClient untuk terhubung ke API Web kami. Selanjutnya, kami akan menambahkan referensi layanan OpenAPI dari file JSON UI Swagger yang sebelumnya kami simpan. Visual Studio akan menghasilkan secara otomatis kelas kode klien yang diperlukan untuk berinteraksi dengan Contoso Pizza Web API. Kami akan melihat kelas kode yang dihasilkan otomatis. Konstruktor membutuhkan instance objek HTTPClient dan URL dasar dari API Web yang sedang berjalan. Jika Anda menjalankan API Web Anda secara lokal, Anda dapat menemukannya dari profil peluncuran debug. Akhirnya, kami dapat membuat kode proyek kami untuk membuat referensi layanan httpclient dan proxy ke Contoso UI Pizza Web API dan mencoba mengambil beberapa pizza. Pastikan aplikasi API Web sudah berjalan secara lokal sebelum menjalankan aplikasi konsol HTTPClient.
Proyek tutorial dan demo ini akan menunjukkan cara mengatur, mengkonfigurasi, dan mengkode tes unit sederhana untuk proyek WebAPI.
Dalam video ini, kita akan membahas cara menulis tes unit sederhana untuk API Web dengan operasi pengontrol CRUD. Kami akan menggunakan paket Xunit dan FakeIteasy untuk menulis tes. Kami akan membahas dasar -dasar pengujian unit, termasuk cara mengatur proyek uji, cara menulis tes untuk setiap operasi CRUD, dan cara menggunakan Xunit dan FakeIteasy untuk membuat tiruan dan stub. Kami juga akan membahas praktik terbaik untuk menulis tes unit, seperti menjaga tes independen dan memastikan bahwa mereka mudah dibaca dan dipelihara.
Meskipun tutorial, video, dan dokumentasi dirujuk, proyek ini secara kreatif kode dan gaya saya sendiri untuk mendemonstrasikan keahlian teknis saya dan berkontribusi pada pengetahuan teknologi kolektif tentang GitHub. Saya telah mendaftarkan beberapa sumber di mana saya menggambar beberapa contoh kode dan pengetahuan.
Serial Pemula untuk: Web API
Microsoft Learn - Buat API Web dengan Asp.Net Core Controllers
Sumber: Percakapan dengan Bing, 11/10/2023 (1) Mulailah dengan swashbuckle dan asp.net core. https: //learn.microsoft.com/en-us/asp .... (2) ASP.NET Core Web API Dokumentasi dengan Swagger/OpenAPI. https: //learn.microsoft.com/en-us/asp .... (3) Apa itu Swagger, Swashbuckle dan Swashbuckle UI. https: //stackoverflow.com/questions/4 .... (4) Meningkatkan pengalaman pengembang API dengan dokumentasi Swagger .... https: //learn.microsoft.com/en-us/tra .... ASP.NET Core Documation di github
JSONPATCH di ASP.NET Core Web API
