ApiChassis

ASP.NET CORE Webapi Chassis

โครงการนี้ตั้งใจที่จะสร้างแชสซี Webapi Core Basic Core เพื่อการพัฒนา API Rampup API การใช้งานที่ระบุไว้ใน 12Factor ของ Heroku, Microservices.io ของ Richardson, Specification OpenAPI มันถูกสร้างขึ้นรอบ ๆ . NET 5 Framework และพร้อมที่จะทำงานบน Docker Stack พร้อมกับเครื่องมือเช่นการจัดการการกำหนดค่าการบันทึกและการแคช

ติดตั้งและเรียกใช้

การติดตั้งและเรียกใช้เทมเพลตรุ่นที่เสถียรล่าสุดเพียงแค่เรียกใช้คำสั่ง folowing:

dotnet new install Xopz.Templates.Api
dotnet new apichassis --name MyApi

รูปแบบที่เลือก

นี่คือรายการของรูปแบบที่นำไปใช้แล้ว

ลวดลาย	คำอธิบาย
แชสซี API	โครงการนี้เองมีการจัดการกับสิ่งอำนวยความสะดวกที่เสนอในรูปแบบแชสซีไมโครเซิร์ตของริชาร์ดสัน เลือกประเภทโครงการ API บริการที่ตั้งใจจะระบุหัวข้อ 12 หัวข้อ VI, VII และ VIII
ตัวชี้วัด API	โครงการนี้ใช้ HealthCheck ออกจากกล่องผ่าน app.UseHealthChecks()
การกำหนดเวอร์ชัน API	โครงการนี้ใช้เวอร์ชัน URL สำหรับ APIs
ความเกลียดชัง	ในความคืบหน้า โครงการนี้เสนอทางเลือกในการขอข้อมูลพร้อมลิงก์ตามที่กล่าวไว้ในข้อกำหนดการเชื่อมโยงเว็บและแนะนำโดย Microsoft
OAS 3.0	โครงการนี้เป็นไปตามข้อกำหนด OpenAPI เวอร์ชันที่สามสำหรับเอกสาร API
พักผ่อน	API นี้ใช้คำแนะนำที่เหลือในการดำเนินการตามคำขอดังนั้นจึงเป็นไปตามข้อกำหนด HTTP เมื่อส่งการตอบกลับและติดตามการแนะนำของ Microsoft

ความต้องการ

เทมเพลตและการใช้งานนี้ขึ้นอยู่กับ. NET 5 ดังนั้นจึงจำเป็นต้องมี. NET SDK หรือเรียกใช้โครงการนี้บนภาพ. NET Docker

สร้าง

สร้างตัวอย่าง API

โซลูชันที่มีความสามารถจะอยู่ในโฟลเดอร์ source โซลูชันแต่ละวิธีควรจะสามารถเปิดได้ใน Visual Studio หรือรหัสสำหรับการแก้ไขการรวบรวมและการดีบัก ในการสร้างโครงการปัจจุบันจากบรรทัดคำสั่งให้ใช้คำสั่ง Follwing:

dotnet build ./source/ApiChassi/ApiChassi.sln

เรียกใช้ชุดทดสอบ

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

dotnet test ./source/ApiChassi/ApiChassi.sln

สร้างแพ็คเกจ NuGet

ในการสร้างแพ็คเกจ NUGET เราเลือกที่จะใช้ภาพ Docker มีสคริปต์ที่กำหนดไว้ล่วงหน้าเพื่อช่วยในการสร้างภาพนักเทียบท่าเครื่องมือ NUGET ที่ต้องการและเพื่อแพ็ค NuGet เป็นเทมเพลต เพื่อสร้างและสร้างในพื้นที่ (แม้ใน Linux หรือ MacOS):

 # EXECUTE THE FOLLOWING COMMANDS AT THE ROOT FOLDER
# CREATES A DOCKER IMAGE LOCALLY TO PACK THE SOURCE
./.environment/scripts/make_nuget.cmd
# CREATES THE NUPKG
./.environment/script/make_package.cmd

วิ่ง

ติดตั้งแพ็คเกจ Nuget ในเครื่อง

สำหรับการทดสอบในท้องถิ่นเป็นไปได้ที่จะติดตั้งไฟล์ nupkg จากโฟลเดอร์ ในการทำเช่นนั้นให้ดำเนินการคำสั่งต่อไปนี้:

dotnet new --install ./Xopz.Templates.Api.0.0.1.nupkg
# CHECK INSTALLED TEMPLATES
dotnet new --list | grep XOPZ
# CREATE SOLUTION FROM TEMPLATE
dotnet new apichassis --name MyApi

ถอนการติดตั้งเทมเพลต

ในการลบเทมเพลตที่ติดตั้ง - ออกจาก nuget.org หรือในเครื่อง - ใช้:

dotnet new --uninstall Xopz.Templates.Api

ทำให้เป็นก้อน