National_Parks_API

API ฐานข้อมูลอุทยานแห่งชาติ (แอปพลิเคชัน C# ASP .NET)

โดย คริสตา รัทซ์

แอปพลิเคชัน API ที่ผู้ใช้สามารถรับและโพสต์ข้อมูลเกี่ยวกับอุทยานแห่งชาติที่โฮสต์บน GitHub อัปเดตล่าสุด 04.03.2020.

คำอธิบาย

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

โปรเจ็กต์นี้ได้รับการพัฒนาในภาษา C# บนแพลตฟอร์ม .NET Core พร้อมการประมวลผลเว็บ ASP.NET Core โดยใช้ไลบรารีรูปแบบ MVC และฐานข้อมูล SQL โดยเฉพาะแอปนี้สร้างขึ้นโดยใช้ Entity Framework และ MySQL เพื่อสร้างสคีมา และโฮสต์บน GitHub

สร้างขึ้นสำหรับโครงการอิสระวันศุกร์ที่ 13 ของ Epicodus ในสัปดาห์ที่ 6 ของหลักสูตร C# และ .NET: "การสร้าง API"

ทักษะมหากาพย์:

• ค#
• รูปแบบ MVC (พร้อม ASP .NET Core 2.2)
• การกำหนดเส้นทาง RESTful และ CRUD
• การโยกย้ายกรอบเอนทิตี
• MySQL Workbench และเซิร์ฟเวอร์
• การพัฒนาที่ขับเคลื่อนด้วยพฤติกรรม (BDD)
• การควบคุมเวอร์ชัน Git และ GitHub
• การสร้าง RESTful API

การติดตั้ง / ตั้งค่า

API นี้ได้รับการบันทึกไว้อย่างครบถ้วน ค้นหาการใช้งานและคำอธิบายในเอกสารประกอบ API

ดาวน์โหลดหรือโคลนพื้นที่เก็บข้อมูลเพื่อรันโปรแกรมนี้ในเครื่อง!

โปรแกรมนี้ต้องใช้ .NET Core SDK จึงจะทำงานได้ นี่คือบทช่วยสอนฟรีสำหรับการติดตั้ง .NET บน Mac หรือ Windows 10

โปรแกรมนี้ยังใช้ฐานข้อมูล SQL เราขอแนะนำให้ใช้ MySQL Workbench เพื่อสร้างฐานข้อมูลของคุณ นี่คือบทช่วยสอนฟรีสำหรับการติดตั้ง MySQL WorkBench และ MySQL Community Server บน Mac หรือ Windows 10

• ดาวน์โหลดหรือโคลน repo นี้
  • วิธีดาวน์โหลด ZIP:
    • เลือก "ดาวน์โหลด" บนไซต์พื้นที่เก็บข้อมูล GitHub
    • เมื่อดาวน์โหลดแล้ว ให้เปิด ZIP และแตกไฟล์ โฟลเดอร์ใหม่จะถูกสร้างขึ้นเป็น 'Week-13-Building-an-API-C-Sharp'
  • การโคลน:
    • โคลนจากบรรทัดคำสั่งไปยังเดสก์ท็อปของคุณ: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • ไดเรกทอรีใหม่จะถูกสร้างขึ้นเป็น 'Desktop/Week-12-Advanced-Databases-and-Authentication-Project'
• เมื่อคุณเก็บไฟล์ไว้ในเครื่องแล้วให้ดำเนินการคำสั่งต่อไปนี้
  • นำทางไปยังไดเร็กทอรีแอปพลิเคชัน: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • $ dotnet ef database update
  • $ dotnet build
  • $ dotnet run
• เมื่อสำเร็จ โปรแกรมจะเริ่มทำงานในคอนโซลของคุณ

เทคโนโลยีที่ใช้

• .NET Core 2.2
  • ฝั่งเซิร์ฟเวอร์ใน C#
• ฐานข้อมูล MySQL
• บุรุษไปรษณีย์

ข้อมูลจำเพาะ

สร้าง API สำหรับรัฐและอุทยานแห่งชาติ API จะแสดงรายการอุทยานแห่งชาติและอุทยานแห่งชาติ นี่คือคุณสมบัติที่จะรวม:

• แอปพลิเคชันมีฟังก์ชัน CRUD และส่งคืนการตอบสนองต่อการเรียก API ได้สำเร็จ
• แอปพลิเคชันมีวัตถุประสงค์การสำรวจเพิ่มเติมอย่างน้อยหนึ่งรายการ: การรับรองความถูกต้อง การกำหนดเวอร์ชัน การแบ่งหน้า เอกสาร Swagger หรือ CORS
• ใบสมัครได้รับการจัดทำเป็นเอกสารไว้อย่างดี รวมถึงเอกสารเฉพาะเกี่ยวกับการสำรวจเพิ่มเติม
• เมื่อคุณปฏิบัติตามข้อกำหนดสำหรับการตรวจสอบโค้ดแล้ว ให้พิจารณาเพิ่มฟังก์ชันอื่นๆ จากการสำรวจเพิ่มเติมของวันจันทร์ สร้างสรรค์และเพิ่มเส้นทาง ขอบเขต และฟังก์ชันการทำงานอื่นๆ ที่กำหนดเองด้วย ความเป็นไปได้อื่นๆ บางประการที่ควรพิจารณา:
  • เพิ่มจุดสิ้นสุด RANDOM ที่ส่งคืนสวนสาธารณะแบบสุ่ม
  • เพิ่มจุดสิ้นสุดที่กำหนดเองอันที่สองที่ยอมรับพารามิเตอร์ ตัวอย่าง: เส้นทาง SEARCH ที่อนุญาตให้ผู้ใช้ค้นหาด้วยชื่ออุทยานเฉพาะ

รหัสของคุณจะได้รับการตรวจสอบตามวัตถุประสงค์ต่อไปนี้:

• แอปพลิเคชันมีฟังก์ชัน CRUD และส่งคืนการตอบสนองต่อการเรียก API ได้สำเร็จ

• แอปพลิเคชันมีวัตถุประสงค์การสำรวจเพิ่มเติมอย่างน้อยหนึ่งรายการ: การรับรองความถูกต้อง การกำหนดเวอร์ชัน การแบ่งหน้า เอกสาร Swagger หรือ CORS

• ใบสมัครได้รับการจัดทำเป็นเอกสารไว้อย่างดี รวมถึงเอกสารเฉพาะเกี่ยวกับการสำรวจเพิ่มเติม

• ประวัติความมุ่งมั่นแสดงการทำงานแปดชั่วโมงอย่างชัดเจน

ข้อบกพร่องที่รู้จัก

• ไม่มีข้อบกพร่องที่รู้จัก

รายละเอียดการสนับสนุนและการติดต่อ

โปรดติดต่อฉันหากคุณพบปัญหาใด ๆ หรือมีคำถาม ความคิด หรือข้อกังวล สามารถติดต่อได้ที่ [email protected] อย่าลังเลที่จะสร้างคำขอดึงข้อมูลอัปเดต - สนับสนุนการมีส่วนร่วมในโค้ด!

ใบอนุญาต

ลิขสิทธิ์ (c) 2020 Krista Rutz

ซอฟต์แวร์นี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT

ดูรายละเอียดใบอนุญาต

อนุญาตให้บุคคลใดก็ตามที่ได้รับสำเนาของซอฟต์แวร์นี้และไฟล์เอกสารที่เกี่ยวข้อง ("ซอฟต์แวร์") อนุญาตโดยไม่เสียค่าใช้จ่าย เพื่อจัดการกับซอฟต์แวร์โดยไม่มีข้อจำกัด รวมถึงแต่ไม่จำกัดเพียงสิทธิ์ในการใช้ คัดลอก ปรับเปลี่ยน ผสาน เผยแพร่ แจกจ่าย ให้อนุญาตช่วง และ/หรือขายสำเนาของซอฟต์แวร์ และอนุญาตให้บุคคลที่ได้รับซอฟต์แวร์นี้สามารถทำได้ ภายใต้เงื่อนไขต่อไปนี้:

ประกาศเกี่ยวกับลิขสิทธิ์ข้างต้นและประกาศการอนุญาตนี้จะรวมอยู่ในสำเนาทั้งหมดหรือส่วนสำคัญของซอฟต์แวร์

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