Rest Api With .Net
شرح واجهات برمجة التطبيقات REST API باستخدام .NET
1. ما هي REST API؟
هي أسلوب يسمح لتطبيقين أو أكثر بالتواصل مع بعضهما عبر الإنترنت وتبادل البيانات.
مثلاً، عندما نستخدم تطبيقاً على الهاتف ونريد عرض معلومات الطلاب، يرسل التطبيق طلباً إلى الخادم، ثم يقوم الخادم بمعالجة الطلب وإرجاع المعلومات المطلوبة.
2. كيف تعمل REST API؟
تتم عملية التواصل وفق الخطوات التالية:
يرسل التطبيق طلباً إلى الخادم.
يستقبل الخادم الطلب ويقوم بمعالجته.
يتصل الخادم بقاعدة البيانات للحصول على المعلومات المطلوبة.
يعيد الخادم النتيجة إلى التطبيق.
أهم المصطلحات:
Client
التطبيق الذي يرسل الطلب.
Server
الخادم الذي يستقبل الطلب ويعالجه.
Database
قاعدة البيانات التي تُخزَّن فيها المعلومات.
Request
الطلب المرسل إلى الخادم.
Response
الاستجابة التي يعيدها الخادم إلى التطبيق.
3. ما علاقة REST API بتقنية .NET؟
نستخدم إطار العمل التالي لبناء واجهات برمجية باستخدام لغة C#:
ASP.NET Core Web API
يساعدنا هذا الإطار البرمجي على إنشاء أنظمة تستقبل الطلبات، وتعالج البيانات، وتتصل بقواعد البيانات، ثم تعيد النتائج إلى التطبيقات.
4. أهم أنواع طلبات HTTP
GET
يُستخدم لجلب البيانات، مثل عرض قائمة الطلاب.
POST
يُستخدم لإضافة بيانات جديدة، مثل إضافة طالب جديد.
PUT
يُستخدم لتحديث البيانات الموجودة، مثل تعديل معلومات طالب.
DELETE
يُستخدم لحذف البيانات، مثل حذف طالب من قاعدة البيانات.
5. مثال عملي باستخدام .NET
csharp
[ApiController]
[Route(“api/[controller]”)]
public class StudentsController : ControllerBase
{
[HttpGet]
public IActionResult GetStudents()
{
var students = new[]
{
new { Id = 1, Name = “Ahmed” },
new { Id = 2, Name = “Ali” }
};
return Ok(students);
}
}
شرح الكود:
ApiController: يحدد الكلاس بوصفه متحكماً خاصاً بواجهة برمجية.
Route: يحدد مسار الوصول إلى الواجهة البرمجية.
HttpGet: يحدد أن الدالة مسؤولة عن جلب البيانات.
IActionResult: يمثل نتيجة الاستجابة.
Ok(): يعيد البيانات بنجاح مع رمز الاستجابة 200.
6. ما هو JSON؟
هو تنسيق يُستخدم لتبادل البيانات بين التطبيقات بطريقة منظمة وسهلة القراءة.
مثال:
json
{
“id”: 1,
“name”: “Ahmed”
}
7. أهم رموز الاستجابة
200 OK
تم تنفيذ الطلب بنجاح.
201 Created
تم إنشاء البيانات الجديدة بنجاح.
400 Bad Request
الطلب المرسل غير صحيح.
401 Unauthorized
المستخدم بحاجة إلى تسجيل الدخول في النظام و ذلك للوصول إلى مسار محمي من خلال الصلاحيات.
Forbidden 403
المستخدم سجل دخوله مسبقاً إلى النظام لكن ليس لديه صلاحية الوصول لهذا المسار المحمي.
404 Not Found
البيانات المطلوبة غير موجودة.
500 Internal Server Error
حدث خطأ داخلي في الخادم.
8. ما المقصود بـ CRUD؟
هي أربع عمليات أساسية تُستخدم للتعامل مع البيانات:
Create
إنشاء بيانات جديدة.
Read
قراءة البيانات وعرضها.
Update
تحديث البيانات الموجودة.
Delete
حذف البيانات.
9. الخلاصة
تُعد REST API وسيلة للتواصل بين الواجهة الأمامية وواجهة الخادم للتطبيق باستخدام بروتوكول HTTP.
وباستخدام ASP.NET Core Web API يمكننا بناء أنظمة واجهة الخادم باستخدام لغة C#، وربطها بقواعد البيانات مثل SQL Server، وتنفيذ عمليات إضافة البيانات وقراءتها وتحديثها وحذفها.