S10L01 - स्प्रिंग बूट REST API का अवलोकन

html


Spring Boot मोनोलिथिक एप्लिकेशन को RESTful APIs में परिवर्तित करना
विषय सूची

परिचय ............................................................. पृष्ठ ३
मोनोलिथिक बनाम RESTful आर्किटेक्चर को समझना ....... पृष्ठ ५
कंट्रोलर को RESTful में परिवर्तित करने के लिए चरण-दर-चरण मार्गदर्शिका ......................... पृष्ठ ८

एक REST कंट्रोलर बनाना
कंट्रोलर क्लास में संशोधन करना
 findAll मेथड को लागू करना
रिस्क्वेस्ट मैपिंग सेटअप करना


कोड व्याख्या और आउटपुट ........................................................ पृष्ठ १२
RESTful APIs का उपयोग कब और कहां करें ....................................... पृष्ठ १५
निष्कर्ष ............................................................. पृष्ठ १८
अतिरिक्त संसाधन ............................................................. पृष्ठ १९

---
परिचय
वेब एप्लिकेशन विकास के हमेशा बदलते परिदृश्य में, लचीलापन और स्केलेबिलिटी अत्यंत महत्वपूर्ण हैं। मोनोलिथिक आर्किटेक्चर लंबे समय से विकास और परिनियोजन में सरलता प्रदान करते आ रहे हैं। हालांकि, जैसे-जैसे एप्लिकेशन बढ़ते हैं, अधिक मॉड्यूलर और स्केलेबल समाधानों की आवश्यकता स्पष्ट हो जाती है। यही वह स्थान है जहाँ RESTful APIs काम में आती हैं, जो विभिन्न प्लेटफार्मों और सेवाओं के बीच निर्बाध संचार की अनुमति देती हैं।
यह eBook एक Spring Boot मोनोलिथिक एप्लिकेशन को RESTful APIs का उपयोग करने वाले में परिवर्तित करने की प्रक्रिया में गहराई से उतरती है। हम आवश्यक चरणों का अन्वेषण करेंगे, अंतर्निहित अवधारणाओं को समझेंगे, और विस्तृत कोड व्याख्याएँ प्रदान करेंगे ताकि आप अपने मौजूदा एप्लिकेशन में RESTful सेवाओं को सहजता से एकीकृत कर सकें।
---
मोनोलिथिक बनाम RESTful आर्किटेक्चर को समझना
परिवर्तन प्रक्रिया में गोता लगाने से पहले, मोनोलिथिक और RESTful आर्किटेक्चर के बुनियादी अंतर को समझना महत्वपूर्ण है।


विशेषता
मोनोलिथिक आर्किटेक्चर
RESTful आर्किटेक्चर


संरचना
एकल एकीकृत कोडबेस
HTTP के माध्यम से संवाद करने वाली स्वतंत्र सेवाएं


स्केलेबिलिटी
सीमित स्केलेबिलिटी; पूरे एप्लिकेशन को स्केल करना
उच्च स्केलेबिलिटी; व्यक्तिगत सेवाओं को स्वतंत्र रूप से स्केल किया जा सकता है


लचीलापन
कम लचीला; परिवर्तन पूरे एप्लिकेशन को प्रभावित करते हैं
बहुत लचीला; सेवाओं को स्वतंत्र रूप से विकसित किया जा सकता है


परिनियोजन
एकल परिनियोजन इकाई
कई परिनियोजन इकाइयां


रखरखाव
जैसे-जैसे एप्लिकेशन बढ़ता है, इसे बनाए रखना अधिक चुनौतीपूर्ण होता है
मॉड्यूलरिटी के कारण रखरखाव आसान होता है


प्रौद्योगिकी स्टैक
आमतौर पर समरूपी
विभिन्न सेवाओं के लिए विविध प्रौद्योगिकी स्टैक का उपयोग कर सकते हैं


मोनोलिथिक आर्किटेक्चर के लाभ:

विकास और परीक्षण में सरलता
डीबगिंग और परफॉर्मेंस मॉनिटरिंग में आसानी
एप्लिकेशन के भीतर कम लेटेंसी संचार

मोनोलिथिक आर्किटेक्चर के नुकसान:

एप्लिकेशन के विशिष्ट हिस्सों को स्केल करना मुश्किल
लंबे परिनियोजन समय
घटक के कड़े जुड़ाव के कारण नई प्रौद्योगिकियों को अपनाना कठिन

RESTful आर्किटेक्चर के लाभ:

उन्नत स्केलेबिलिटी और लचीलापन
सेवाओं का स्वतंत्र परिनियोजन और विकास
बेहतर फॉल्ट आइसोलेशन

RESTful आर्किटेक्चर के नुकसान:

विकास और डीबगिंग में वृद्धि हुई जटिलता
नेटवर्क संचार के कारण संभावित उच्च लेटेंसी
मजबूत API प्रबंधन और सुरक्षा उपायों की आवश्यकता

इन अंतरों को समझना यह तय करने में महत्वपूर्ण है कि क्या आपकी एप्लिकेशन की बढ़ती मांगों को पूरा करने के लिए RESTful आर्किटेक्चर की ओर संक्रमण करना चाहिए।
---
कंट्रोलर को RESTful में परिवर्तित करने के लिए चरण-दर-चरण मार्गदर्शिका
एक मोनोलिथिक Spring Boot एप्लिकेशन में RESTful APIs शामिल करने के लिए परिवर्तित करना विशिष्ट चरणों में शामिल होता है। यह मार्गदर्शिका मौजूदा कंट्रोलर को REST कंट्रोलर में परिवर्तित करने के लिए एक व्यापक दृष्टिकोण प्रदान करती है।
एक REST कंट्रोलर बनाना
परिवर्तन प्रक्रिया का पहला चरण एक मौजूदा कंट्रोलर को डुप्लिकेट करके एक नया REST कंट्रोलर बनाना है।




		
		
			
			
Java
			
			// मौजूदा कंट्रोलर
@Controller
public class HomeController {
    // कंट्रोलर मेथड्स
}

			
				
					
				
					1
2
3
4
5
6
				
						// मौजूदा कंट्रोलर
@Controller
public class HomeController {
    // कंट्रोलर मेथड्स
}
 
					
				
			
		





		
		
			
			
Java
			
			// नया REST कंट्रोलर
@RestController
public class HomeRestController {
    // REST कंट्रोलर मेथड्स
}

			
				
					
				
					1
2
3
4
5
6
				
						// नया REST कंट्रोलर
@RestController
public class HomeRestController {
    // REST कंट्रोलर मेथड्स
}
 
					
				
			
		


कंट्रोलर क्लास में संशोधन करना
कंट्रोलर को डुप्लिकेट करने के बाद, इसे एक RESTful एंडपॉइंट के रूप में कार्य करने के लिए क्लास को समायोजित करना आवश्यक है।

कंट्रोलर का नाम बदलें: क्लास का नाम बदलकर इसके RESTful स्वभाव को दर्शाएं, जैसे HomeRestController.
@RestController के साथ एनोटेट करें: @Controller को @RestController से बदलें ताकि REST-विशिष्ट विशेषताएं सक्षम हो सकें।
अनावश्यक पैरामीटर्स हटाएं: उन पैरामीटर्स को साफ करें जो RESTful प्रतिक्रियाओं के लिए आवश्यक नहीं हैं।





		
		
			
			
Java
			
			
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {

    @Autowired
    private PostService postService;

    @GetMapping("/posts")
    public List<Post> getAllPosts() {
        return postService.findAll();
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
				
						 
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {
 
    @Autowired
    private PostService postService;
 
    @GetMapping("/posts")
    public List<Post> getAllPosts() {
        return postService.findAll();
    }
}
 
					
				
			
		


 findAll मेथड को लागू करना
findAll मेथड सेवा परत से सभी पोस्ट्स को पुनः प्राप्त करता है, उन्हें JSON प्रतिक्रिया के रूप में लौटाता है।




		
		
			
			
Java
			
			
@GetMapping("/posts")
public List<Post> getAllPosts() {
    return postService.findAll();
}

			
				
					
				
					1
2
3
4
5
6
				
						 
@GetMapping("/posts")
public List<Post> getAllPosts() {
    return postService.findAll();
}
 
					
				
			
		


व्याख्या:

@GetMapping("/posts"): HTTP GET अनुरोधों को /api/v1/posts पर मैप करता है।
postService.findAll(): डेटाबेस से सभी पोस्ट संस्थाओं को प्राप्त करता है।
एक JSON प्रारूप में Post ऑब्जेक्ट्स की सूची लौटाता है।

रिस्क्वेस्ट मैपिंग सेटअप करना
अपने REST कंट्रोलर के लिए एक बेस URL परिभाषित करना सुनिश्चित करता है कि API एंडपॉइंट्स संगठित और सुसंगत रहें।




		
		
			
			
Java
			
			
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {
    // कंट्रोलर मेथड्स
}

			
				
					
				
					1
2
3
4
5
6
7
				
						 
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {
    // कंट्रोलर मेथड्स
}
 
					
				
			
		


व्याख्या:

@RequestMapping("/api/v1"): इस कंट्रोलर में सभी एंडपॉइंट्स के लिए बेस URL सेट करता है, जो /api/v1 से शुरू होता है।

---
कोड व्याख्या और आउटपुट
आइए कोड परिवर्तनों में गहराई से उतरते हैं और REST कंट्रोलर द्वारा उत्पन्न आउटपुट को समझते हैं।
पूर्ण REST कंट्रोलर कोड




		
		
			
			
Java
			
			
package org.studyeasy.SpringBlog.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.studyeasy.SpringBlog.models.Post;
import org.studyeasy.SpringBlog.services.PostService;

import java.util.List;

@RestController
@RequestMapping("/api/v1")
public class HomeRestController {

    @Autowired
    private PostService postService;

    /**
     * सभी पोस्ट्स को पुनः प्राप्त करता है और उन्हें JSON एरे के रूप में लौटाता है।
     * 
     * @return Post ऑब्जेक्ट्स की सूची
     */
    @GetMapping("/posts")
    public List<Post> getAllPosts() {
        return postService.findAll();
    }
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
				
						 
package org.studyeasy.SpringBlog.controller;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.studyeasy.SpringBlog.models.Post;
import org.studyeasy.SpringBlog.services.PostService;
 
import java.util.List;
 
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {
 
    @Autowired
    private PostService postService;
 
    /**
     * सभी पोस्ट्स को पुनः प्राप्त करता है और उन्हें JSON एरे के रूप में लौटाता है।
     * 
     * @return Post ऑब्जेक्ट्स की सूची
     */
    @GetMapping("/posts")
    public List<Post> getAllPosts() {
        return postService.findAll();
    }
}
 
					
				
			
		


चरण-दर-चरण कोड ब्रेकडाउन

पैकेज घोषणा:

        



		
		
			
			
Java
			
			
package org.studyeasy.SpringBlog.controller;

			
				
					
				
					1
2
3
				
						 
package org.studyeasy.SpringBlog.controller;
 
					
				
			
		



कंट्रोलर के रहने वाले पैकेज को परिभाषित करता है।


इम्पोर्ट्स:

        



		
		
			
			
Java
			
			
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.studyeasy.SpringBlog.models.Post;
import org.studyeasy.SpringBlog.services.PostService;

import java.util.List;

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
				
						 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.studyeasy.SpringBlog.models.Post;
import org.studyeasy.SpringBlog.services.PostService;
 
import java.util.List;
 
					
				
			
		



REST कार्यक्षमता के लिए आवश्यक क्लासेज़ और एनोटेशन्स को इम्पोर्ट करता है।


क्लास एनोटेशन:

        



		
		
			
			
Java
			
			
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {
    //...
}

			
				
					
				
					1
2
3
4
5
6
7
				
						 
@RestController
@RequestMapping("/api/v1")
public class HomeRestController {
    //...
}
 
					
				
			
		



@RestController: संकेत करता है कि यह क्लास RESTful वेब सेवाओं को संभालती है।
@RequestMapping("/api/v1"): इस कंट्रोलर में सभी एंडपॉइंट्स के लिए बेस URL सेट करता है।


डिपेंडेंसी इंजेक्शन:

        



		
		
			
			
Java
			
			
@Autowired
private PostService postService;

			
				
					
				
					1
2
3
4
				
						 
@Autowired
private PostService postService;
 
					
				
			
		



डेटा लेयर के साथ इंटरैक्ट करने के लिए PostService को इंजेक्ट करता है।


एंडपॉइंट मेथड:

        



		
		
			
			
Java
			
			
@GetMapping("/posts")
public List<Post> getAllPosts() {
    return postService.findAll();
}

			
				
					
				
					1
2
3
4
5
6
				
						 
@GetMapping("/posts")
public List<Post> getAllPosts() {
    return postService.findAll();
}
 
					
				
			
		



@GetMapping("/posts"): HTTP GET अनुरोधों को /api/v1/posts पर मैप करता है।
getAllPosts(): मेथड जो सभी पोस्ट्स को पुनः प्राप्त करता है और उन्हें JSON एरे के रूप में लौटाता है।



नमूना आउटपुट
जब http://localhost:8080/api/v1/posts पर GET अनुरोध किया जाता है, प्रतिक्रिया में सभी पोस्ट ऑब्जेक्ट्स का एक JSON एरे मिलेगा।




		
		
			
			
Java
			
			[
    {
        "id": 1,
        "title": "Spring Boot में परिचय",
        "content": "Spring Boot से स्टैंड-अलोन, प्रोडक्शन-ग्रेड Spring आधारित एप्लिकेशन बनाना आसान हो जाता है।",
        "author": "John Doe",
        "createdAt": "2023-10-01T10:00:00Z"
    },
    {
        "id": 2,
        "title": "RESTful APIs बनाना",
        "content": "RESTful APIs क्लाइंट और सर्वर के बीच निर्बाध संचार की अनुमति देती हैं।",
        "author": "Jane Smith",
        "createdAt": "2023-10-02T12:30:00Z"
    }
]

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
				
						[
    {
        "id": 1,
        "title": "Spring Boot में परिचय",
        "content": "Spring Boot से स्टैंड-अलोन, प्रोडक्शन-ग्रेड Spring आधारित एप्लिकेशन बनाना आसान हो जाता है।",
        "author": "John Doe",
        "createdAt": "2023-10-01T10:00:00Z"
    },
    {
        "id": 2,
        "title": "RESTful APIs बनाना",
        "content": "RESTful APIs क्लाइंट और सर्वर के बीच निर्बाध संचार की अनुमति देती हैं।",
        "author": "Jane Smith",
        "createdAt": "2023-10-02T12:30:00Z"
    }
]
 
					
				
			
		


व्याख्या:

API पोस्ट्स की एक सूची लौटाती है, प्रत्येक में id, title, content, author, और createdAt जैसे गुण शामिल हैं।
@RestController सुनिश्चित करता है कि प्रतिक्रिया स्वचालित रूप से JSON में परिवर्तित हो जाती है।

---
RESTful APIs का उपयोग कब और कहां करें
अपने Spring Boot एप्लिकेशन में RESTful APIs को एकीकृत करना कई लाभ प्रदान करता है, विशेष रूप से उन परिदृश्यों में जहां स्केलेबिलिटी और इंटरऑपरेबिलिटी की आवश्यकता होती है।
RESTful APIs के उपयोग के मामले

मोबाइल एप्लिकेशन: ऐसी मोबाइल ऐप्स के लिए बैकएंड सेवाएं प्रदान करें जिन्हें JSON प्रारूप में डेटा की आवश्यकता होती है।
सिंगल पेज एप्लिकेशन (SPAs): Angular या React जैसे फ्रंट-एंड फ्रेमवर्क को डायनेमिक डेटा प्रदान करके सुधारें।
माइक्रोसर्विसेज़ आर्किटेक्चर: एक बड़े सिस्टम के भीतर स्वतंत्र माइक्रोसर्विसेज़ के बीच संचार को सुविधाजनक बनाएं।
थर्ड-पार्टी इंटीग्रेशंस: बाहरी एप्लिकेशन को आपकी सेवाओं के साथ सुरक्षित और कुशलतापूर्वक इंटरैक्ट करने की अनुमति दें।

प्रायोगिक परिदृश्यों में लाभ

लचीलापन:

क्लाइंट विभिन्न प्रोग्रामिंग भाषाओं और प्लेटफार्मों का उपयोग करके APIs का उपभोग कर सकते हैं।


स्केलेबिलिटी:

आवश्यकतानुसार स्वतंत्र सेवाओं को स्केल किया जा सकता है बिना पूरे एप्लिकेशन को प्रभावित किए।


रखरखाव:

मॉड्यूलर सेवाएं अपडेट और रखरखाव को सरल बनाती हैं, सिस्टम-वाइड विफलताओं के जोखिम को कम करती हैं।


पुन: उपयोग:

सामान्य सेवाओं को विभिन्न एप्लिकेशन में पुन: उपयोग किया जा सकता है, जिससे विकास की दक्षता बढ़ती है।


सुरक्षा:

APIs मजबूत सुरक्षा उपायों जैसे OAuth, JWT, और API गेटवे को लागू कर सकती हैं ताकि डेटा की अखंडता बनी रहे।



कब मोनोलिथिक की तुलना में RESTful को चुनें

बढ़ते एप्लिकेशन: जैसे-जैसे एप्लिकेशन का विस्तार होता है, एकल कोडबेस का प्रबंधन कठिन हो जाता है। RESTful APIs बेहतर संगठन और प्रबंधन सक्षम करती हैं।
विविध क्लाइंट आवश्यकताएँ: जब कई क्लाइंट्स (वेब, मोबाइल, थर्ड-पार्टी सेवाएँ) को एक ही डेटा तक पहुंचने की आवश्यकता होती है, RESTful APIs एक केंद्रीय और मानकीकृत इंटरफेस प्रदान करती हैं।
स्वतंत्र विकास: टीमें विभिन्न सेवाओं पर एक साथ काम कर सकती हैं बिना एक-दूसरे के कोडबेस में हस्तक्षेप किए, जिससे उत्पादकता बढ़ती है।

---
निष्कर्ष
एक मोनोलिथिक Spring Boot एप्लिकेशन से RESTful APIs को शामिल करने वाली में परिवर्तित करना लचीले, स्केलेबिल, और मेंटिनेबल सिस्टम बनाने की दिशा में एक रणनीतिक कदम है। कंट्रोलर्स को REST कंट्रोलर्स में परिवर्तित करके, आप विविध क्लाइंट इंटरैक्शन, निर्बाध इंटीग्रेशंस, और कुशल डेटा प्रबंधन के लिए रास्ते खोलते हैं।
इस eBook ने परिवर्तन प्रक्रिया पर एक व्यापक मार्गदर्शिका प्रदान की, आर्किटेक्चरल अंतर को समझने से लेकर आवश्यक कोड परिवर्तनों को लागू करने और समझाने तक। RESTful APIs को अपनाने से न केवल आपका एप्लिकेशन आधुनिक बनता है, बल्कि यह उद्योग की सर्वोत्तम प्रथाओं के साथ भी संरेखित होता है, जिससे आज के गतिशील विकास परिदृश्य में इसकी प्रासंगिकता और प्रदर्शन सुनिश्चित होता है।
SEO कीवर्ड्स: Spring Boot, RESTful APIs, monolithic architecture, microservices, Spring controller, REST controller, API development, scalable applications, Spring Boot tutorial, converting controllers, JSON APIs, Spring Boot REST API, API endpoints, software architecture, web services
---
अतिरिक्त संसाधन

Spring Boot आधिकारिक दस्तावेज़
RESTful API डिज़ाइन सर्वोत्तम प्रथाएँ
Spring Boot के साथ RESTful वेब सेवा बनाना
माइक्रोसर्विसेज़ आर्किटेक्चर को समझना
Spring Security के साथ RESTful APIs को सुरक्षित करना
Postman - API विकास पर्यावरण
JSON.org - JSON का परिचय

---
पढ़ने के लिए धन्यवाद! Spring Boot और RESTful API विकास पर अधिक जानकारियों और ट्यूटोरियल के लिए, हमारे आगामी अध्यायों पर बने रहें।
नोट: यह लेख AI द्वारा उत्पन्न किया गया है।

S10L01 – स्प्रिंग बूट REST API का अवलोकन

Spring Boot मोनोलिथिक एप्लिकेशन को RESTful APIs में परिवर्तित करना

विषय सूची

परिचय

मोनोलिथिक बनाम RESTful आर्किटेक्चर को समझना

कंट्रोलर को RESTful में परिवर्तित करने के लिए चरण-दर-चरण मार्गदर्शिका

एक REST कंट्रोलर बनाना

कंट्रोलर क्लास में संशोधन करना

`findAll` मेथड को लागू करना

रिस्क्वेस्ट मैपिंग सेटअप करना

कोड व्याख्या और आउटपुट

पूर्ण REST कंट्रोलर कोड

चरण-दर-चरण कोड ब्रेकडाउन

नमूना आउटपुट

RESTful APIs का उपयोग कब और कहां करें

RESTful APIs के उपयोग के मामले

प्रायोगिक परिदृश्यों में लाभ

कब मोनोलिथिक की तुलना में RESTful को चुनें

निष्कर्ष

अतिरिक्त संसाधन

विशेषता	मोनोलिथिक आर्किटेक्चर	RESTful आर्किटेक्चर
संरचना	एकल एकीकृत कोडबेस	HTTP के माध्यम से संवाद करने वाली स्वतंत्र सेवाएं
स्केलेबिलिटी	सीमित स्केलेबिलिटी; पूरे एप्लिकेशन को स्केल करना	उच्च स्केलेबिलिटी; व्यक्तिगत सेवाओं को स्वतंत्र रूप से स्केल किया जा सकता है
लचीलापन	कम लचीला; परिवर्तन पूरे एप्लिकेशन को प्रभावित करते हैं	बहुत लचीला; सेवाओं को स्वतंत्र रूप से विकसित किया जा सकता है
परिनियोजन	एकल परिनियोजन इकाई	कई परिनियोजन इकाइयां
रखरखाव	जैसे-जैसे एप्लिकेशन बढ़ता है, इसे बनाए रखना अधिक चुनौतीपूर्ण होता है	मॉड्यूलरिटी के कारण रखरखाव आसान होता है
प्रौद्योगिकी स्टैक	आमतौर पर समरूपी	विभिन्न सेवाओं के लिए विविध प्रौद्योगिकी स्टैक का उपयोग कर सकते हैं