ProWebAPI

เอกสารนี้ให้รายละเอียดการใช้งาน ASP.NET Core API ที่แข็งแกร่งและเป็นมาตรฐานโดยใช้ ProWebAPI โดยครอบคลุมประเด็นสำคัญต่างๆ เช่น การรวม Swagger, การแทรกการพึ่งพา, การตอบสนองที่เป็นมาตรฐาน, การกำหนดเวอร์ชัน, การตรวจสอบคำขอ, การรองรับ OData v4, การจัดการข้อยกเว้นทั่วโลก และ EF Core พร้อม UnitOfWork คู่มือนี้จะให้คำแนะนำทีละขั้นตอนสำหรับแต่ละส่วนประกอบ

ProWebAPI

ASP.NET Core API พร้อมมาตรฐานที่เหมาะสมทั้งหมด

มาตรฐานที่นำไปใช้

กร่าง

ติดตั้งสแวกเกอร์

ตั้งค่า DI

การตอบสนองมาตรฐานสำหรับ API

การตอบสนองมาตรฐาน

การกำหนดเวอร์ชัน

ติดตั้งไลบรารี Nuget

เพิ่มลงในคอนเทนเนอร์การพึ่งพา

ตกแต่งคอนโทรลเลอร์ตามความต้องการ

ขอเครื่องมือตรวจสอบ

ติดตั้งไลบรารี Nuget

ลงทะเบียนผู้ตรวจสอบความถูกต้องบน DI

ในเนมสเปซ 'RequestDto' ให้เพิ่มเครื่องมือตรวจสอบพร้อมกับ dto

สร้าง ValidationFilter

ลงทะเบียนตัวกรองและปิด [ApiController] auto 400 Bad Request intercept

AppSettings.json

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

สร้างการกำหนดค่าสภาพแวดล้อม 2 รายการ

โอดาต้า v4

เพื่อรองรับ OData ให้ติดตั้ง NuGetpackages

เพิ่มไปยังบริการ DI สำหรับ OData

กำหนดค่า OData

แทนที่แอตทริบิวต์ [EnableQuery] ด้วย [EnableOData] เพื่อตรวจจับข้อผิดพลาดและส่งกลับการตอบสนองมาตรฐาน

ตกแต่งวิธีการดำเนินการ

ค้นหาตาม URL

ตัวจัดการข้อยกเว้นสากล

สร้างมิดเดิลแวร์

สร้างวิธีการขยายสำหรับตัวสร้างแอป

ลงทะเบียนมิดเดิลแวร์

ปลอกตอบสนอง

อนุญาตให้ใช้ตัวพิมพ์สมาชิก (ซึ่งจะอยู่ในตัวพิมพ์ปาสคาลสำหรับอุปกรณ์ประกอบฉาก) เพื่อให้ผลลัพธ์การสืบค้น OData จะไม่ขัดแย้งกับตัวพิมพ์

EF Core + หน่วยการทำงาน

เพิ่มไลบรารีคลาสที่รองรับ

ติดตั้งแพ็คเกจที่จำเป็นบน ProWeb.Data

เพื่อเรียกใช้การโยกย้าย

ตั้งค่า ProWeb.Data เป็น [โครงการเริ่มต้น] และดำเนินการย้ายข้อมูล