• نویسنده
• آگوست 10, 2019

ساخت وب سرویس برای بازگرداندن داده های XML و JSON در .NET

در دنیای دیجیتال امروز، اپلیکیشن‌ها دیگر جزایری منزوی نیستند. آن‌ها برای ارائه خدمات بهتر، نیازمند گفتگو و تبادل داده با یکدیگر هستند. وب سرویس‌ها (Web Services) شاه‌راه‌های این ارتباطات مدرن محسوب می‌شوند. آن‌ها به برنامه‌های مختلف اجازه می‌دهند تا داده‌ها را به صورت استاندارد تبادل کنند. 🌐 در این مقاله، به صورت کامل و قدم به قدم یاد می‌گیریم که چگونه یک وب سرویس در محیط .NET بسازیم. این وب سرویس قادر خواهد بود داده‌ها را در دو فرمت بسیار محبوب یعنی XML و JSON بازگرداند. این دانش یک مهارت بنیادی برای هر توسعه‌دهنده بک‌اند است. پس با ما همراه باشید.

وب سرویس چیست و چرا اهمیت دارد؟

تصور کنید اپلیکیشن موبایل شما می‌خواهد آخرین وضعیت آب‌وهوا را نمایش دهد. این اطلاعات روی سرورهای یک سازمان هواشناسی قرار دارد. وب سرویس مانند یک پیشخدمت حرفه‌ای عمل می‌کند. اپلیکیشن شما درخواستی را به وب سرویس می‌فرستد. سپس وب سرویس اطلاعات را از پایگاه داده واکشی کرده و در یک فرمت استاندارد به اپلیکیشن شما تحویل می‌دهد.

اهمیت وب سرویس‌ها در یکپارچه‌سازی (Integration) سیستم‌های مختلف است. این فناوری به پلتفرم‌های متفاوت (مثلاً یک سایت PHP و یک اپلیکیشن اندروید) اجازه می‌دهد تا به سادگی با هم صحبت کنند.

XML و JSON: دو غول تبادل داده

برای اینکه دو سیستم بتوانند با هم صحبت کنند، به یک زبان مشترک نیاز دارند. JSON و XML  دو زبان استاندارد و محبوب برای بسته‌بندی و انتقال داده‌ها در وب هستند.

XML چیست؟

eXtensible Markup Language یعنی xml. این فرمت از تگ‌ها برای تعریف ساختار داده‌ها استفاده می‌کند. ساختار آن شبیه به HTML است اما وظیفه‌اش نمایش داده نیست، بلکه توصیف و حمل داده است.

نمونه کد XML:

<Employee>
  <EmpId>1</EmpId>
  <EmpFirstName>Ali</EmpFirstName>
  <EmpLastName>Ahmadi</EmpLastName>
</Employee>

JSON چیست؟

JSON مخفف JavaScript Object Notation است. این فرمت بسیار سبک‌تر و خواناتر از XML است. JSON داده‌ها را به صورت زوج‌های «کلید-مقدار» (Key-Value) نمایش می‌دهد. به همین دلیل، در سال‌های اخیر به انتخاب اول برای APIهای مدرن تبدیل شده است.

نمونه کد JSON:

{
  "EmpId": 1,
  "EmpFirstName": "Ali",
  "EmpLastName": "Ahmadi"
}

مزایای کلیدی استفاده از وب سرویس برای بازگرداندن داده‌ها

استفاده از وب سرویس‌ها برای تبادل داده‌های XML و JSON مزایای بی‌شماری دارد. این رویکرد به شما کمک می‌کند تا برنامه‌هایی مقیاس‌پذیر و انعطاف‌پذیر بسازید. در ادامه به مهم‌ترین مزیت‌ها اشاره می‌کنیم.

• ✅ استقلال از پلتفرم: کلاینت (مصرف‌کننده سرویس) می‌تواند با هر زبان یا تکنولوژی نوشته شده باشد. یک سرویس .NET می‌تواند به راحتی به کلاینت‌های پایتون، جاوا یا جاوااسکریپت سرویس دهد.
• 🚀 افزایش سرعت توسعه: تیم‌های مختلف (مثلاً تیم فرانت‌اند و بک‌اند) می‌توانند به صورت موازی کار کنند. آن‌ها فقط بر سر ساختار داده‌های XML یا JSON توافق می‌کنند.
• 🔄 قابلیت استفاده مجدد: شما می‌توانید یک وب سرویس را یک بار بنویسید. سپس آن را در پروژه‌های متعدد (وب‌سایت، اپلیکیشن موبایل، نرم‌افزار دسکتاپ) استفاده کنید.
• 🛠️ نگهداری و مدیریت آسان: منطق اصلی برنامه در سمت سرور متمرکز است. بنابراین، به‌روزرسانی‌ها و تغییرات بدون نیاز به آپدیت کردن تمام کلاینت‌ها انجام می‌شود.

کاربردهای عملی وب سرویس‌های XML و JSON

وب سرویس‌ها تقریباً در تمام نرم‌افزارهای مدرن کاربرد دارند. آن‌ها زیربنای بسیاری از سرویس‌هایی هستند که روزانه از آن‌ها استفاده می‌کنیم. بیایید چند مثال واقعی را بررسی کنیم.

• 📱 اپلیکیشن‌های موبایل: تقریباً تمام اپلیکیشن‌ها برای دریافت اطلاعات، ارسال داده و احراز هویت از وب سرویس‌ها استفاده می‌کنند.
• 🛒 فروشگاه‌های اینترنتی: فرآیندهایی مانند بررسی موجودی کالا، پردازش پرداخت و رهگیری سفارش همگی از طریق وب سرویس‌ها مدیریت می‌شوند.
• 💡 اینترنت اشیاء (IoT): سنسورها و دستگاه‌های هوشمند داده‌های خود را از طریق وب سرویس‌ها به سرور مرکزی ارسال می‌کنند تا تحلیل و پردازش شوند.
• 💳 درگاه‌های پرداخت بانکی: وقتی خریدی آنلاین انجام می‌دهید، وب‌سایت شما از طریق یک وب سرویس امن با سیستم بانک ارتباط برقرار می‌کند.

راهنمای گام‌به‌گام ساخت وب سرویس (API) در .NET

اکنون به بخش عملی ماجرا می‌رسیم. ما قصد داریم با استفاده از ASP.NET Core Web API یک وب سرویس مدرن بسازیم. این روش جایگزین رویکردهای قدیمی‌تر مانند ASMX Web Service شده است.

قدم اول: ایجاد پروژه ASP.NET Core Web API

ابتدا ویژوال استودیو را باز کنید. سپس یک پروژه جدید از نوع ASP.NET Core Web API ایجاد نمایید. فریمورک .NET 6 یا نسخه‌های جدیدتر را انتخاب کنید.

قدم دوم: تعریف مدل داده (Model)

یک کلاس ساده برای نگهداری اطلاعات کارمندان ایجاد می‌کنیم. این کلاس ساختار داده‌ای که قرار است بازگردانده شود را مشخص می‌کند.

public class Employee
{
    public int EmpId { get; set; }
    public string? EmpFirstName { get; set; }
    public string? EmpLastName { get; set; }
    public int DeptId { get; set; }
}

قدم سوم: ساخت کنترلر (Controller)

کنترلر وظیفه مدیریت درخواست‌های ورودی را بر عهده دارد. یک کنترلر جدید به نام EmployeesController ایجاد کنید. سپس یک متد (Action Method) برای بازگرداندن لیست کارمندان به آن اضافه کنید.

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("api/[controller]")]
public class EmployeesController : ControllerBase
{
    [HttpGet]
    public IActionResult GetEmployees()
    {
        // در یک پروژه واقعی، این داده‌ها از دیتابیس خوانده می‌شوند
        var employees = new List<Employee>
        {
            new Employee { EmpId = 1, EmpFirstName = "Sara", EmpLastName = "Moradi", DeptId = 101 },
            new Employee { EmpId = 2, EmpFirstName = "Reza", EmpLastName = "Alavi", DeptId = 102 }
        };

        return Ok(employees);
    }
}

قدم چهارم: تنظیم فرمت خروجی XML و JSON

خبر خوب این است که ASP.NET Core به طور پیش‌فرض خروجی JSON تولید می‌کند. ✨ برای فعال‌سازی خروجی XML، کافی است یک خط کد به فایل Program.cs اضافه کنید.

// در فایل Program.cs
builder.Services.AddControllers()
    .AddXmlSerializerFormatters(); // این خط را اضافه کنید

حالا وب سرویس شما هوشمند است! اگر کلاینت در هدر درخواست خود Accept: application/json را ارسال کند، خروجی JSON دریافت می‌کند. اگر Accept: application/xml را بفرستد، خروجی XML تحویل می‌گیرد.

ثبت‌نام و دسترسی به APIهای قدرتمند

بسیاری از سرویس‌ها و پلتفرم‌های حرفه‌ای، APIهای آماده و قدرتمندی را ارائه می‌دهند. برای استفاده از این APIها معمولاً نیاز به ثبت‌نام و دریافت یک کلید دسترسی (API Key) دارید. این کلید هویت شما را برای سرویس‌دهنده مشخص می‌کند.

برای مثال، اگر به دنبال APIهای کاربردی و متنوع ایرانی هستید، می‌توانید فرآیند ثبت‌نام را به سادگی انجام دهید. برای شروع و مشاهده لیست سرویس‌ها، کافی است در پلتفرم p.api.ir ثبت‌نام کنید و مستندات مربوطه را دنبال نمایید.

جمع‌بندی نهایی

در این مقاله، ما سفری از مفاهیم تئوری تا پیاده‌سازی عملی داشتیم. دیدیم که وب سرویس‌ها چگونه ارتباط بین نرم‌افزارهای مختلف را ممکن می‌سازند. همچنین با دو فرمت محبوب XML و JSON برای بازگرداندن داده‌ها آشنا شدیم. در نهایت، یاد گرفتیم که چگونه با استفاده از ASP.NET Core یک وب سرویس مدرن بسازیم که قادر به ارائه خروجی در هر دو فرمت باشد.

اکنون شما دانش پایه‌ای و در عین حال قدرتمندی برای ورود به دنیای APIها و میکروسرویس‌ها در اختیار دارید. 🚀

شما چه تجربه‌ای در کار با وب سرویس‌های XML و JSON دارید؟ نظرات و سوالات خود را در بخش دیدگاه‌ها با ما در میان بگذارید.

• برچسب ها:
• Web Service برای بازگرداندن داده ها
• بازگرداندن داده های JSON
• بازگرداندن داده های XML
• وب سرویس