S04L03 – सूची एल्बम API बनाएं, Spring Boot

html

स्प्रिंग बूट के साथ View Albums API बनाना: एक व्यापक मार्गदर्शिका
सामग्री तालिका

परिचय
परियोजना की स्थापना
Album Controller बनाना
Service Layer कार्यान्वयन
Repository कॉन्फ़िगरेशन
API सुरक्षा
Swagger के साथ परीक्षण
निष्कर्ष


परिचय
स्प्रिंग बूट का उपयोग करके View Albums API बनाने पर इस व्यापक मार्गदर्शिका में आपका स्वागत है। आज के डिजिटल युग में, उपयोगकर्ता-विशिष्ट डेटा को सुरक्षित और कुशलतापूर्वक प्रबंधित करना अत्यंत महत्वपूर्ण है। यह eBook आपको लॉग इन किए गए उपयोगकर्ता के आधार पर सभी एल्बम सूचीबद्ध करने वाला API बनाने की प्रक्रिया के माध्यम से ले जाएगा। चाहे आप एक शुरुआती हों या बुनियादी ज्ञान वाले डेवलपर, यह मार्गदर्शिका स्प्रिंग बूट के साथ API विकास के मूल तत्वों में महारत हासिल करने में आपकी मदद के लिए तैयार की गई है।
महत्व और उद्देश्य
उपयोगकर्ता-विशिष्ट एल्बम सूचीबद्ध API बनाना उन अनुप्रयोगों के लिए महत्वपूर्ण है जो व्यक्तिगत डेटा को संभालते हैं। यह सुनिश्चित करता है कि प्रत्येक उपयोगकर्ता केवल अपने स्वयं के एल्बमों तक ही पहुंच सकता है, जिससे डेटा सुरक्षा और उपयोगकर्ता अनुभव में सुधार होता है। यह मार्गदर्शिका परियोजना की स्थापना से लेकर API को सुरक्षित और परीक्षण करने की चरण-दर-चरण प्रक्रिया को कवर करती है।
लाभ और हानि


लाभ
हानि


उपयोगकर्ता-विशिष्ट डेटा एक्सेस के साथ बढ़ी हुई सुरक्षा
स्प्रिंग बूट और प्रमाणीकरण तंत्र की समझ आवश्यक


विभिन्न अनुप्रयोगों के लिए उपयुक्त स्केलेबल वास्तुकला
शुरुआती सेटअप शुरुआती के लिए समय-साध्य हो सकता है


अन्य सेवाओं और डेटाबेस के साथ आसान एकीकरण
सुरक्षा और कार्यक्षमता सुनिश्चित करने के लिए व्यापक परीक्षण आवश्यक


कब और कहाँ उपयोग करें
यह API उन अनुप्रयोगों के लिए आदर्श है जो उपयोगकर्ता-जनित सामग्री का प्रबंधन करते हैं, जैसे कि फोटो गैलरी, संगीत पुस्तकालय, या कोई भी सेवा जहाँ उपयोगकर्ताओं के पास व्यक्तिगत संग्रह होते हैं। अपने प्रोजेक्ट में इसे लागू करने से डेटा की अखंडता और व्यक्तिगत उपयोगकर्ता अनुभव सुनिश्चित होता है।

परियोजना की स्थापना
विकास प्रक्रिया में कदम रखने से पहले, सुनिश्चित करें कि आपका विकास वातावरण सही ढंग से स्थापित है।
आवश्यकताएँ

Java Development Kit (JDK) स्थापित हो
Spring Boot फ्रेमवर्क
Maven प्रोजेक्ट प्रबंधन के लिए
IDE जैसे IntelliJ IDEA या Eclipse
RESTful APIs और Spring Boot का बुनियादी ज्ञान

स्प्रिंग बूट प्रोजेक्ट प्रारंभ करना

नया स्प्रिंग बूट प्रोजेक्ट बनाएं: स्प्रिंग इनिशियलाइज़र या अपने IDE का उपयोग करके एक नया स्प्रिंग बूट प्रोजेक्ट प्रारंभ करें। स्प्रिंग वेब, स्प्रिंग डेटा JPA, और स्प्रिंग सिक्योरिटी के लिए डिपेंडेंसी शामिल करें।
प्रोजेक्ट संरचना: स्पष्टता और रखरखाव के लिए अपने प्रोजेक्ट को निम्न संरचना के साथ व्यवस्थित करें:

    



		
		
			
			
Java
			
			src/main/java/org/studyeasy/SpringRestdemo/
├── config/
├── controller/
├── model/
├── payload/
├── repository/
├── security/
├── service/
└── util/constants/
			
				
					
				
					1
2
3
4
5
6
7
8
9
				
						src/main/java/org/studyeasy/SpringRestdemo/
├── config/
├── controller/
├── model/
├── payload/
├── repository/
├── security/
├── service/
└── util/constants/
					
				
			
		


  
application.properties कॉन्फ़िगर करें: अपनी डेटाबेस कॉन्फ़िगरेशन और अन्य आवश्यक गुण सेट करें।


Album Controller बनाना
Controller आने वाले HTTP अनुरोधों को संभालता है और डेटा को संसाधित करने के लिए Service layer के साथ इंटरैक्ट करता है।
AlbumController.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.security.core.Authentication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.studyeasy.SpringRestdemo.payload.auth.album.AlbumViewDTO;
import org.studyeasy.SpringRestdemo.service.AlbumService;

import java.util.ArrayList;
import java.util.List;

@RestController
public class AlbumController {

    @Autowired
    private AlbumService albumService;

    @GetMapping(value = "/albums", produces = MediaType.APPLICATION_JSON_VALUE)
    public List<AlbumViewDTO> getAlbums(Authentication authentication) {
        List<AlbumViewDTO> albums = new ArrayList<>();
        Long accountId = albumService.getAccountId(authentication);
        
        albumService.findAllByAccountId(accountId).forEach(album -> {
            AlbumViewDTO albumView = new AlbumViewDTO();
            albumView.setId(album.getId());
            albumView.setName(album.getName());
            albumView.setDescription(album.getDescription());
            albums.add(albumView);
        });
        
        return albums;
    }
}
			
				
					
				
					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
31
32
33
34
35
				
						package org.studyeasy.SpringRestdemo.controller;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.security.core.Authentication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.studyeasy.SpringRestdemo.payload.auth.album.AlbumViewDTO;
import org.studyeasy.SpringRestdemo.service.AlbumService;
 
import java.util.ArrayList;
import java.util.List;
 
@RestController
public class AlbumController {
 
    @Autowired
    private AlbumService albumService;
 
    @GetMapping(value = "/albums", produces = MediaType.APPLICATION_JSON_VALUE)
    public List<AlbumViewDTO> getAlbums(Authentication authentication) {
        List<AlbumViewDTO> albums = new ArrayList<>();
        Long accountId = albumService.getAccountId(authentication);
        
        albumService.findAllByAccountId(accountId).forEach(album -> {
            AlbumViewDTO albumView = new AlbumViewDTO();
            albumView.setId(album.getId());
            albumView.setName(album.getName());
            albumView.setDescription(album.getDescription());
            albums.add(albumView);
        });
        
        return albums;
    }
}
					
				
			
		


व्याख्या

@RestController: संकेत करता है कि यह क्लास RESTful वेब सेवाओं को संभालती है।
@GetMapping("/albums"): HTTP GET अनुरोधों को getAlbums मेथड से मैप करता है।
Authentication Parameter: वर्तमान में लॉग इन किए गए उपयोगकर्ता के प्रमाणीकरण विवरण प्राप्त करता है।
AlbumService: व्यवसायिक लॉजिक को संभालने के लिए इंजेक्ट किया गया है जो एल्बम से संबंधित है।
AlbumViewDTO: प्रतिक्रिया में एल्बम डेटा भेजने के लिए डेटा ट्रांसफर ऑब्जेक्ट।


Service Layer कार्यान्वयन
Service layer में व्यवसायिक लॉजिक होता है और यह Controller और Repository के बीच संचार करता है।
AlbumService.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.Authentication;
import org.springframework.stereotype.Service;
import org.studyeasy.SpringRestdemo.model.Album;
import org.studyeasy.SpringRestdemo.repository.AlbumRepository;

import java.util.List;

@Service
public class AlbumService {

    @Autowired
    private AlbumRepository albumRepository;

    public Long getAccountId(Authentication authentication) {
        // प्रमाणीकरण से account ID निकालें
        // कार्यान्वयन आपके सुरक्षा सेटअप पर निर्भर करता है
        return 1L; // प्लेसहोल्डर
    }

    public List<Album> findAllByAccountId(Long accountId) {
        return albumRepository.findByAccountId(accountId);
    }
}
			
				
					
				
					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
				
						package org.studyeasy.SpringRestdemo.service;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.Authentication;
import org.springframework.stereotype.Service;
import org.studyeasy.SpringRestdemo.model.Album;
import org.studyeasy.SpringRestdemo.repository.AlbumRepository;
 
import java.util.List;
 
@Service
public class AlbumService {
 
    @Autowired
    private AlbumRepository albumRepository;
 
    public Long getAccountId(Authentication authentication) {
        // प्रमाणीकरण से account ID निकालें
        // कार्यान्वयन आपके सुरक्षा सेटअप पर निर्भर करता है
        return 1L; // प्लेसहोल्डर
    }
 
    public List<Album> findAllByAccountId(Long accountId) {
        return albumRepository.findByAccountId(accountId);
    }
}
					
				
			
		


व्याख्या

@Service: इस क्लास को एक सेवा प्रदाता के रूप में चिह्नित करता है।
AlbumRepository: डेटाबेस के साथ इंटरैक्ट करने के लिए इंजेक्ट किया गया है।
getAccountId: प्रमाणीकरण ऑब्जेक्ट से account ID प्राप्त करता है।
findAllByAccountId: एक विशिष्ट account ID से संबंधित सभी एल्बम प्राप्त करता है।


Repository कॉन्फ़िगरेशन
Repository layer सीधे डेटाबेस के साथ इंटरैक्ट करता है, जिससे डेटा मॉडल पर CRUD ऑपरेशन्स करने की सुविधा मिलती है।
AlbumRepository.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.repository;

import org.springframework.data.jpa.repository.JpaRepository;
import org.studyeasy.SpringRestdemo.model.Album;

import java.util.List;

public interface AlbumRepository extends JpaRepository<Album, Long> {
    List<Album> findByAccountId(Long accountId);
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
				
						package org.studyeasy.SpringRestdemo.repository;
 
import org.springframework.data.jpa.repository.JpaRepository;
import org.studyeasy.SpringRestdemo.model.Album;
 
import java.util.List;
 
public interface AlbumRepository extends JpaRepository<Album, Long> {
    List<Album> findByAccountId(Long accountId);
}
					
				
			
		


व्याख्या

JpaRepository: मानक डेटा एक्सेस के लिए JPA संबंधित मेथड प्रदान करता है।
findByAccountId: account ID के आधार पर एल्बम प्राप्त करने के लिए कस्टम मेथड। मेथड नाम स्प्रिंग डेटा JPA की क्वेरी डेरिवेशन के लिए नामकरण नियमों का पालन करता है।


API सुरक्षा
सुनिश्चित करना कि केवल प्रमाणित उपयोगकर्ता ही API तक पहुंच सकते हैं, डेटा सुरक्षा के लिए महत्वपूर्ण है।
SecurityConfig.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.security;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        // सरलता के लिए इन-मेमोरी प्रमाणीकरण
        auth.inMemoryAuthentication()
            .withUser("user")
            .password("{noop}password")
            .roles("USER")
            .and()
            .withUser("admin")
            .password("{noop}admin123")
            .roles("ADMIN");
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .csrf().disable()
            .authorizeRequests()
                .antMatchers("/albums").authenticated()
                .and()
            .httpBasic();
    }
}
			
				
					
				
					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
31
32
33
				
						package org.studyeasy.SpringRestdemo.security;
 
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 
@Configuration
public class SecurityConfig extends WebSecurityConfigurerAdapter {
 
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        // सरलता के लिए इन-मेमोरी प्रमाणीकरण
        auth.inMemoryAuthentication()
            .withUser("user")
            .password("{noop}password")
            .roles("USER")
            .and()
            .withUser("admin")
            .password("{noop}admin123")
            .roles("ADMIN");
    }
 
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .csrf().disable()
            .authorizeRequests()
                .antMatchers("/albums").authenticated()
                .and()
            .httpBasic();
    }
}
					
				
			
		


व्याख्या

@Configuration: संकेत करता है कि क्लास में स्प्रिंग कॉन्फ़िगरेशन है।
In-Memory Authentication: दो उपयोगकर्ताओं (user और admin) को भूमिकाओं के साथ परिभाषित करता है।
HttpSecurity Configuration:

csrf().disable(): सरलता के लिए CSRF सुरक्षा अक्षम करता है।
authorizeRequests(): निर्दिष्ट करता है कि /albums एन्डपॉइंट के लिए प्रमाणीकरण आवश्यक है।
httpBasic(): बुनियादी HTTP प्रमाणीकरण सक्षम करता है।




Swagger के साथ परीक्षण
Swagger आपके API के लिए इंटरैक्टिव डॉक्यूमेंटेशन प्रदान करता है, जिससे इसे परीक्षण और समझना आसान हो जाता है।
SwaggerConfig.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {                                    
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.basePackage("org.studyeasy.SpringRestdemo.controller"))              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
				
						package org.studyeasy.SpringRestdemo.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
 
@Configuration
@EnableSwagger2
public class SwaggerConfig {                                    
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.basePackage("org.studyeasy.SpringRestdemo.controller"))              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}
					
				
			
		


व्याख्या

@EnableSwagger2: प्रोजेक्ट के लिए Swagger 2 को सक्षम करता है।
Docket Bean: Swagger को Controller पैकेज को स्कैन करने और सभी API एन्डपॉइंट्स का डॉक्यूमेंटेशन बनाने के लिए कॉन्फ़िगर करता है।

परीक्षण के चरण

एप्लिकेशन चलाएं: अपना स्प्रिंग बूट एप्लिकेशन स्टार्ट करें।
Swagger UI एक्सेस करें: http://localhost:8080/swagger-ui.html पर जाएं।
टोकन जनरेट करें: परिभाषित उपयोगकर्ताओं का उपयोग करके प्रमाणीकरण करें और टोकन प्राप्त करें।
एन्डपॉइंट्स का परीक्षण करें: Swagger के इंटरफेस का उपयोग करके /albums एन्डपॉइंट के साथ इंटरैक्ट करें और कार्यक्षमता की पुष्टि करें।


निष्कर्ष
इस मार्गदर्शिका में, हमने View Albums API को Spring Boot के साथ बनाने की पूरी प्रक्रिया पर चर्चा की है। परियोजना की स्थापना और Controller बनाने से लेकर Service और Repository layers के कार्यान्वयन, API की सुरक्षा, और Swagger के साथ परीक्षण तक, प्रत्येक चरण एक मजबूत और सुरक्षित अनुप्रयोग विकसित करने के लिए महत्वपूर्ण है। इस मार्गदर्शिका का पालन करके, आप सुनिश्चित कर सकते हैं कि आपका API उपयोगकर्ता-विशिष्ट डेटा को कुशलतापूर्वक संभालता है, जिससे एक सहज उपयोगकर्ता अनुभव प्रदान होता है।
मुख्य बिंदु

संरचित प्रोजेक्ट सेटअप: संगठित प्रोजेक्ट संरचना रखरखाव में सुधार करती है।
Service और Repository Layers: चिंता के साफ-सुथरे विभाजन के लिए आवश्यक हैं।
सुरक्षा: प्रमाणीकरण लागू करने से डेटा सुरक्षा सुनिश्चित होती है।
Swagger के साथ परीक्षण: आसान API परीक्षण और डॉक्यूमेंटेशन को सुविधाजनक बनाता है।

हमारे आगामी ट्यूटोरियल के लिए बने रहें जहाँ हम उन्नत विषयों जैसे मल्टीपल फाइल सपोर्ट के साथ फाइल अपलोडिंग और एल्बम में फोटो अटैचमेंट्स पर चर्चा करेंगे। खुश कोडिंग!
नोट: यह लेख AI द्वारा जनरेट किया गया है।
लाभ	हानि
उपयोगकर्ता-विशिष्ट डेटा एक्सेस के साथ बढ़ी हुई सुरक्षा	स्प्रिंग बूट और प्रमाणीकरण तंत्र की समझ आवश्यक
विभिन्न अनुप्रयोगों के लिए उपयुक्त स्केलेबल वास्तुकला	शुरुआती सेटअप शुरुआती के लिए समय-साध्य हो सकता है
अन्य सेवाओं और डेटाबेस के साथ आसान एकीकरण	सुरक्षा और कार्यक्षमता सुनिश्चित करने के लिए व्यापक परीक्षण आवश्यक