C# में 30 मिनट में REST API कैसे लिखें: शुरुआती लोगों के लिए

परिचय: C# में REST API — जितना लगता है उससे कहीं आसान

वेब एप्लिकेशन और माइक्रोसर्विसेज का विकास REST API के बिना अधूरा है। यदि आप प्रोग्रामिंग में अपनी यात्रा शुरू कर रहे हैं, तो अपना खुद का API बनाना एक कठिन कार्य लग सकता है। हालांकि, C# में ASP.NET Core फ्रेमवर्क के साथ, आप सचमुच 30 मिनट में एक कार्यशील RESTful सेवा लिख सकते हैं।

इस मार्गदर्शिका में, हम चरण दर चरण कार्यों की सूची (Todo List) के प्रबंधन के लिए एक सरल API बनाएंगे। आप सीखेंगे कि प्रोजेक्ट कैसे सेट करें, डेटा मॉडल, कंट्रोलर कैसे बनाएं और एंडपॉइंट का परीक्षण कैसे करें। कोई जादू नहीं — केवल स्वच्छ कोड और स्पष्ट स्पष्टीकरण।

लेख के अंत तक, आपके पास पूरी तरह से कार्यशील API होगा जो सभी बुनियादी CRUD ऑपरेशन (Create, Read, Update, Delete) का समर्थन करता है।

चरण 1: वातावरण तैयार करना और प्रोजेक्ट बनाना

कोड लिखने से पहले, सुनिश्चित करें कि आपके पास आवश्यक उपकरण स्थापित हैं:

\n
• .NET SDK (संस्करण 8.0 या नया) — Microsoft की आधिकारिक वेबसाइट से डाउनलोड करें
\n
• Visual Studio (2022 Community Edition) या C# एक्सटेंशन के साथ Visual Studio Code
\n
• परीक्षण के लिए Postman या कोई अन्य REST-क्लाइंट
\n

टर्मिनल (या कमांड प्रॉम्प्ट) खोलें और नया Web API प्रोजेक्ट बनाने के लिए निम्न कमांड चलाएँ:

dotnet new webapi -n TodoApi\ncd TodoApi

प्रोजेक्ट बनाने के बाद, अपनी IDE में TodoApi फ़ोल्डर खोलें। प्रोजेक्ट संरचना में कई फ़ोल्डर और फ़ाइलें होंगी, लेकिन अभी हम तीन मुख्य चीज़ों में रुचि रखते हैं: Program.cs, Controllers और Models।

चरण 2: डेटा मॉडल बनाना

मॉडल एक क्लास है जो हमारे API के डेटा की संरचना का वर्णन करता है। कार्यों की सूची के लिए, हमें तीन फ़ील्ड चाहिए: एक अद्वितीय पहचानकर्ता, नाम और पूर्णता स्थिति।

प्रोजेक्ट की रूट में एक नया फ़ोल्डर Models बनाएँ, और उसके अंदर एक फ़ाइल TodoItem.cs बनाएँ:

namespace TodoApi.Models;\n\npublic class TodoItem\n{\n    public int Id { get; set; }\n    public string? Name { get; set; }\n    public bool IsComplete { get; set; }\n}

string के बाद प्रश्न चिह्न पर ध्यान दें। यह इंगित करता है कि Name प्रॉपर्टी null हो सकती है। कंपाइलर चेतावनियों से बचने के लिए यह एक अच्छी प्रथा है।

चरण 3: कंट्रोलर बनाना और CRUD लागू करना

कंट्रोलर एक क्लास है जो HTTP अनुरोधों को संसाधित करता है। ASP.NET Core में, कंट्रोलर ControllerBase से विरासत प्राप्त करते हैं और रूटिंग के लिए एट्रीब्यूट का उपयोग करते हैं।

Controllers फ़ोल्डर में एक फ़ाइल TodoItemsController.cs बनाएँ:

using Microsoft.AspNetCore.Mvc;\nusing TodoApi.Models;\n\nnamespace TodoApi.Controllers;\n\n[ApiController]\n[Route("api/[controller]")]\npublic class TodoItemsController : ControllerBase\n{\n    private static List<TodoItem> _todoItems = new();\n\n    // GET: api/TodoItems\n    [HttpGet]\n    public ActionResult<IEnumerable<TodoItem>> GetTodoItems()\n    {\n        return _todoItems;\n    }\n\n    // GET: api/TodoItems/1\n    [HttpGet("{id}")]\n    public ActionResult<TodoItem> GetTodoItem(int id)\n    {\n        var item = _todoItems.FirstOrDefault(t => t.Id == id);\n        if (item == null)\n            return NotFound();\n        return item;\n    }\n\n    // POST: api/TodoItems\n    [HttpPost]\n    public ActionResult<TodoItem> PostTodoItem(TodoItem item)\n    {\n        item.Id = _todoItems.Count + 1;\n        _todoItems.Add(item);\n        return CreatedAtAction(nameof(GetTodoItem), new { id = item.Id }, item);\n    }\n\n    // PUT: api/TodoItems/1\n    [HttpPut("{id}")]\n    public IActionResult PutTodoItem(int id, TodoItem updatedItem)\n    {\n        var existingItem = _todoItems.First