National_Parks_API

API Database Taman Nasional (Aplikasi C# ASP .NET)

Oleh Krista Rutz

Aplikasi API tempat pengguna dapat memperoleh dan memposting informasi tentang taman nasional, yang dihosting di GitHub. Terakhir Diperbarui 04.03.2020.

Keterangan

Aplikasi ini memungkinkan pengguna membuat entri database tentang taman nasional, memungkinkan mereka menambahkan nama, negara bagian, kode taman, wilayah, url situs web, dan catatan tentang buka atau tidaknya taman tersebut. Kemampuan untuk mendapatkan dan memposting taman disertakan, selain fungsi memasang dan menghapus.

Proyek ini dikembangkan dalam C# pada platform .NET Core dengan pemrosesan web ASP.NET Core, menggunakan pustaka pola MVC dan database SQL. Secara khusus, aplikasi ini dibuat menggunakan Entity Framework dan MySQL untuk membuat skema, dan dihosting di GitHub.

Itu dibuat untuk proyek independen Jumat ke-13 Epicodus, pada minggu ke-6 kursus C# dan .NET: "Membangun API".

Keterampilan Epicodus:

• C#
• Pola MVC (dengan ASP .NET Core 2.2)
• Perutean tenang dan CRUD
• Migrasi kerangka entitas
• Meja Kerja MySQL dan server
• Pengembangan yang didorong oleh perilaku (BDD)
• Kontrol versi Git dan GitHub
• Bangunan API yang tenang

Instalasi / Pengaturan

API ini didokumentasikan sepenuhnya. Temukan penggunaan dan penjelasannya dalam dokumen Dokumentasi API.

Unduh atau klon repositori untuk menjalankan program ini secara lokal!

Program ini memerlukan .NET Core SDK untuk dijalankan. Berikut ini tutorial gratis untuk menginstal .NET di Mac atau Windows 10.

Program ini juga menggunakan database SQL. Kami merekomendasikan penggunaan MySQL Workbench untuk membangun database Anda. Berikut ini tutorial gratis untuk menginstal MySQL WorkBench dan MySQL Community Server di Mac atau Windows 10.

• Unduh atau kloning repo ini.
  • Untuk Mengunduh ZIP:
    • Pilih "Unduh" di situs Repositori GitHub
    • Setelah diunduh, buka ZIP dan ekstrak file. Folder baru akan dibuat sebagai 'Minggu-13-Building-an-API-C-Sharp'.
  • Untuk Mengkloning:
    • Kloning dari baris perintah ke Desktop Anda: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • Direktori baru akan dibuat sebagai 'Desktop/Minggu-12-Advanced-Databases-and-Authentication-Project'.
• Setelah Anda menyimpan file secara lokal, jalankan perintah berikut.
  • Arahkan ke direktori aplikasi: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • $ dotnet ef database update
  • $ dotnet build
  • $ dotnet run
• Setelah berhasil, program akan mulai berjalan di konsol Anda.

Teknologi yang Digunakan

• .NET Inti 2.2
  • Sisi server di C#
• basis data MySQL
• Tukang pos

Spesifikasi

Buat API untuk taman negara bagian dan nasional. API akan mencantumkan taman negara bagian dan nasional. Berikut adalah fitur yang disertakan:

• Aplikasi menyertakan fungsionalitas CRUD dan berhasil mengembalikan respons terhadap panggilan API.
• Aplikasi mencakup setidaknya satu dari tujuan eksplorasi lebih lanjut: autentikasi, pembuatan versi, penomoran halaman, dokumentasi Swagger, atau CORS.
• Aplikasi didokumentasikan dengan baik, termasuk dokumentasi spesifik untuk eksplorasi lebih lanjut.
• Setelah Anda menyelesaikan persyaratan untuk peninjauan kode, pertimbangkan untuk menambahkan fungsi lain dari Eksplorasi Lebih Lanjut hari Senin. Jadilah kreatif dan tambahkan juga rute, cakupan, dan fungsionalitas khusus lainnya. Berikut beberapa kemungkinan lain yang perlu dipertimbangkan:
  • Tambahkan titik akhir RANDOM yang mengembalikan taman secara acak.
  • Tambahkan titik akhir kustom kedua yang menerima parameter. Contoh: rute SEARCH yang memungkinkan pengguna mencari berdasarkan nama taman tertentu.

Kode Anda akan ditinjau untuk tujuan berikut:

• Aplikasi menyertakan fungsionalitas CRUD dan berhasil mengembalikan respons terhadap panggilan API.

• Aplikasi mencakup setidaknya satu dari tujuan eksplorasi lebih lanjut: autentikasi, pembuatan versi, penomoran halaman, dokumentasi Swagger, atau CORS.

• Aplikasi didokumentasikan dengan baik, termasuk dokumentasi spesifik untuk eksplorasi lebih lanjut.

• Riwayat komitmen dengan jelas menunjukkan delapan jam kerja.

Bug yang Diketahui

• Tidak ada bug yang diketahui

Detail dukungan dan kontak

Silakan hubungi saya jika Anda mengalami masalah atau memiliki pertanyaan, ide, atau kekhawatiran. Saya dapat dihubungi di [email protected]. Jangan ragu untuk membuat permintaan tarik untuk pembaruan - kontribusi pada kode sangat dianjurkan!

Lisensi

Hak Cipta (c) 2020 Krista Rutz

Perangkat lunak ini dilisensikan di bawah lisensi MIT.

Lihat detail lisensi

Izin dengan ini diberikan, secara gratis, kepada siapa pun yang memperoleh salinan perangkat lunak ini dan file dokumentasi terkait ("Perangkat Lunak"), untuk menggunakan Perangkat Lunak tanpa batasan, termasuk namun tidak terbatas pada hak untuk menggunakan, menyalin, memodifikasi, menggabungkan , mempublikasikan, mendistribusikan, mensublisensikan, dan/atau menjual salinan Perangkat Lunak, dan mengizinkan orang yang menerima Perangkat Lunak untuk melakukan hal tersebut, dengan tunduk pada ketentuan berikut:

Pemberitahuan hak cipta di atas dan pemberitahuan izin ini akan disertakan dalam semua salinan atau sebagian besar Perangkat Lunak.

PERANGKAT LUNAK INI DISEDIAKAN "APA ADANYA", TANPA JAMINAN APA PUN, TERSURAT MAUPUN TERSIRAT, TERMASUK NAMUN TIDAK TERBATAS PADA JAMINAN KELAYAKAN UNTUK DIPERDAGANGKAN, KESESUAIAN UNTUK TUJUAN TERTENTU, DAN TIDAK ADA PELANGGARAN. DALAM KEADAAN APA PUN PENULIS ATAU PEMEGANG HAK CIPTA TIDAK BERTANGGUNG JAWAB ATAS KLAIM, KERUSAKAN, ATAU TANGGUNG JAWAB LAINNYA, BAIK DALAM TINDAKAN KONTRAK, HUKUM ATAU LAINNYA, YANG TIMBUL DARI, ATAU SEHUBUNGAN DENGAN PERANGKAT LUNAK ATAU PENGGUNAAN ATAU HAL-HAL LAIN DALAM PERANGKAT LUNAK.