JsonApiDotNetCore

jsonapidotnetcore

กรอบการทำงานสำหรับการสร้าง JSON: API REST ที่สอดคล้องกับ API โดยใช้. NET Core และ Entity Framework Core รวมถึงการสนับสนุนสำหรับการดำเนินการอะตอม

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

เริ่มต้น

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

เกี่ยวกับ

• JSON: API คืออะไรและทำไมฉันถึงใช้มัน? (บล็อก, 2017)
• Pragmatic JSON: API Design (วิดีโอ, 2017)
• JSON: API และ JSONAPIDOTNETCORE (วิดีโอ, 2021)
• jsonapidotnetcore รีลีส 4.0 (บล็อก, 2020)
• JSON: API, .NET CORE, Emberjs (วิดีโอ, 2017)
• Embercasts: Full Stack Ember กับ ASP.NET CORE (หลักสูตร PAY, 2017)

เอกสารอย่างเป็นทางการ

• ข้อกำหนด JSON: API
• เว็บไซต์ jsonapidotnetcore
• แผนงาน

โครงการที่เกี่ยวข้อง

• รายงานประสิทธิภาพ
• jsonapidotnetcore.mongoDB
• ember.js todo list แอป

ตัวอย่าง

ดูไดเรกทอรีตัวอย่างสำหรับแอปพลิเคชันตัวอย่างที่ทันสมัย นอกจากนี้ยังมีแอพ Tode List ที่มี Jsonapidotnetcore API และไคลเอนต์ EmberJS

การติดตั้งและการใช้งาน

ดูเอกสารของเราสำหรับการใช้งานโดยละเอียด

แบบจำลอง

#nullable enable

[ Resource ]
public class Article : Identifiable < int >
{
    [ Attr ]
    public string Name { get ; set ; } = null ! ;
}

มิดเดิลแวร์

 // Program.cs

builder . Services . AddJsonApi < AppDbContext > ( ) ;

// ...

app . UseRouting ( ) ;
app . UseJsonApi ( ) ;
app . MapControllers ( ) ; 

ความเข้ากันได้

แผนภูมิต่อไปนี้ควรช่วยคุณเลือกเวอร์ชันที่ดีที่สุดตามสภาพแวดล้อมของคุณ ดูนโยบายการกำหนดเวอร์ชันของเราด้วย

jsonapidotnetcore	สถานะ	.สุทธิ	แกนเฟรมเวิร์กเอนทิตี
3.x	มั่นคง	Core 2.x	2.x
4.x	มั่นคง	แกน 3.1	3.1, 5
		5	5
		6	5
5.0.0-5.0.2	มั่นคง	6	6
5.0.3-5.4.0	มั่นคง	6	6, 7
		7	7
5.5+	มั่นคง	6	6, 7
		7	7
		8	8, 9
		9	9
ผู้เชี่ยวชาญ	ดูตัวอย่าง	8	8, 9
		9	9
Openapi	เกี่ยวกับการทดลอง	8	8, 9
		9	9

การบริจาค

มีคำถามพบข้อผิดพลาดหรือต้องการส่งการเปลี่ยนแปลงรหัสหรือไม่? ดูแนวทางการสนับสนุนของเรา

ลองสร้างล่าสุด

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

1. สร้างโทเค็นการเข้าถึงส่วนบุคคล (คลาสสิก) อย่างน้อย read:packages

2. เพิ่มแหล่งแพ็คเกจของเราไปยังไฟล์ nuget.config เฉพาะผู้ใช้ในพื้นที่ของคุณโดยเรียกใช้:

   dotnet nuget add source https://nuget.pkg.github.com/json-api-dotnet/index.json --name github-json-api --username YOUR-GITHUB-USERNAME --password YOUR-PAT-CLASSIC

   ในคำสั่งด้านบน:

   • แทนที่ชื่อผู้ใช้ github-username ของคุณด้วยชื่อผู้ใช้ที่คุณใช้เพื่อเข้าสู่ระบบบัญชี GitHub ของคุณ
   • แทนที่ pat-classic ของคุณด้วยโทเค็นที่คุณสร้างขึ้นด้านบน

   หากคำสั่งข้างต้นไม่ให้คุณเข้าถึงในขั้นตอนถัดไปให้ลบแหล่งแพ็คเกจโดยเรียกใช้:

   dotnet nuget remove source github-json-api

   และลองอีกครั้งด้วยสวิตช์ --store-password-in-clear-text

3. รีสตาร์ท IDE ของคุณเปิดโครงการของคุณและเรียกดูรายการแพ็คเกจจากฟีด GitHub-JSON-API (ตรวจสอบให้แน่ใจว่ามีแพ็คเกจวางจำหน่ายล่วงหน้า)

การพัฒนา

ในการสร้างรหัสจากที่เก็บนี้ในพื้นที่ให้เรียกใช้:

dotnet build

การเรียกใช้การทดสอบในเครื่องต้องการการเข้าถึงฐานข้อมูล PostgreSQL หากคุณติดตั้ง Docker สิ่งนี้สามารถวางได้ผ่าน:

pwsh run-docker-postgres.ps1

จากนั้นทำการทดสอบ:

dotnet test

อีกทางเลือกหนึ่งในการสร้างเรียกใช้การทดสอบทั้งหมดสร้างความครอบคลุมรหัสและแพ็คเกจ NuGet:

pwsh Build.ps1

ผู้สนับสนุน