S04L12 - अपडेट एल्बम एपीआई

html

Spring REST में Update Album API को लागू करना: एक व्यापक गाइड
विषय सूची

परिचय ......................................................... 1
Update Album API को समझना .... 3

API अवलोकन .................................................. 3
मुख्य घटक ............................................ 4


प्रोजेक्ट सेटअप करना ............................ 6

प्रोजेक्ट संरचना ................................... 6


Update Album API को लागू करना ..... 8

DTOs: डेटा ट्रांसफर ऑब्जेक्ट्स ................. 8
Controller लेयर ......................................... 10
Service लेयर ................................................. 12
Repository लेयर ...................................... 14


सुरक्षा और प्राधिकरण ..................... 16
Update Album API का परीक्षण ............... 18
निष्कर्ष .......................................................... 20


परिचय
वेब विकास के निरंतर बदलते परिदृश्य में, APIs (एप्लिकेशन प्रोग्रामिंग इंटरफेसेस) विभिन्न सॉफ़्टवेयर घटकों के बीच निर्बाध इंटरैक्शन सक्षम करने के लिए रीढ़ की हड्डी के रूप में कार्य करते हैं। कई अनुप्रयोगों में एक ऐसा ही आवश्यक API है Update Album API, जो उपयोगकर्ताओं को मौजूदा एल्बम विवरण को संशोधित करने की अनुमति देता है। चाहे आप एक फोटो गैलरी, संगीत मंच, या किसी भी प्रकार के संग्रह प्रबंधित करने वाले अनुप्रयोग का निर्माण कर रहे हों, इस तरह के API को लागू और अनुकूलित करने की समझ महत्वपूर्ण है।
यह गाइड Spring REST का उपयोग करके एक Update Album API बनाने की प्रक्रिया में गहराई से जाता है, जो Java में मजबूत और स्केलेबल वेब सेवाओं के निर्माण के लिए एक शक्तिशाली फ्रेमवर्क है। शुरुआती और बुनियादी ज्ञान वाले डेवलपर्स के लिए अनुकूलित, यह ईबुक चरण-दर-चरण दृष्टिकोण प्रदान करता है, कोड अंश, व्याख्याएँ, और सर्वोत्तम प्रथाओं के साथ संपन्न है ताकि आपके विकास यात्रा में स्पष्टता और दक्षता सुनिश्चित हो सके।

Update Album API को समझना
API अवलोकन
एक Update Album API अनुप्रयोग में मौजूदा एल्बम के विवरण को संशोधित करने का प्राथमिक कार्य करता है। इसमें एल्बम के नाम, विवरण, और संबंधित फोटो जैसे गुणों को अपडेट करना शामिल है। इस API को लागू करने से यह सुनिश्चित होता है कि उपयोगकर्ता अपनी एल्बम जानकारी को वर्तमान और प्रासंगिक रख सकें।
मुख्य संचालन:

मान्यकरण: सुनिश्चित करें कि अपडेट करने का अनुरोध करने वाले उपयोगकर्ता के पास आवश्यक अनुमतियाँ हैं।
Payload हैंडलिंग: एल्बम के लिए नए डेटा को प्राप्त और प्रोसेस करना।
पर्सिस्टेंस: अपडेट किए गए विवरण को डेटाबेस में सहेजना।
प्रतिक्रिया: अपडेट किए गए एल्बम की जानकारी को क्लाइंट को लौटाना।

मुख्य घटक

DTOs (Data Transfer Objects): क्लाइंट और सर्वर के बीच डेटा के ट्रांसफर को सुविधाजनक बनाते हैं।
Controller: आने वाले HTTP अनुरोधों को संभालता है और उन्हें उपयुक्त Service मेथड्स की ओर निर्देशित करता है।
Service: अपडेट को प्रोसेस करने के लिए व्यापार लॉजिक शामिल करता है।
Repository: डेटाबेस से डेटा पर्सिस्टेंस और रिट्रीवल को प्रबंधित करता है।
Security: यह सुनिश्चित करता है कि केवल अधिकृत उपयोगकर्ता ही अपडेट ऑपरेशन्स को अंजाम दे सकें।


प्रोजेक्ट सेटअप करना
लागूकरण में उतरने से पहले, यह आवश्यक है कि प्रोजेक्ट वातावरण को सही ढंग से सेटअप किया जाए।
प्रोजेक्ट संरचना
एक सुव्यवस्थित प्रोजेक्ट संरचना रखरखाव और स्केलेबिलिटी को बढ़ाता है। यहाँ एक Spring REST आवेदन के लिए विशिष्ट संरचना का अवलोकन दिया गया है:




		
		
			
			
Java
			
			spring-restdemo
├── src
│   ├── main
│   │   ├── java
│   │   │   └── org.studyeasy.SpringRestdemo
│   │   │       ├── SpringRestdemoApplication.java
│   │   │       ├── config
│   │   │       │   └── SwaggerConfig.java
│   │   │       ├── controller
│   │   │       │   └── AlbumController.java
│   │   │       ├── model
│   │   │       │   ├── Album.java
│   │   │       │   └── Photo.java
│   │   │       ├── payload
│   │   │       │   └── album
│   │   │       │       ├── AlbumPayloadDTO.java
│   │   │       │       └── AlbumViewDTO.java
│   │   │       ├── repository
│   │   │       │   ├── AlbumRepository.java
│   │   │       │   └── PhotoRepository.java
│   │   │       ├── security
│   │   │       │   └── SecurityConfig.java
│   │   │       └── service
│   │   │           └── AlbumService.java
│   │   └── resources
│   │       └── application.properties
│   └── test
│       └── java
│           └── org.studyeasy.SpringRestdemo
│               └── SpringRestdemoApplicationTests.java
├── pom.xml
└── README.md
			
				
					
				
					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
				
						spring-restdemo
├── src
│   ├── main
│   │   ├── java
│   │   │   └── org.studyeasy.SpringRestdemo
│   │   │       ├── SpringRestdemoApplication.java
│   │   │       ├── config
│   │   │       │   └── SwaggerConfig.java
│   │   │       ├── controller
│   │   │       │   └── AlbumController.java
│   │   │       ├── model
│   │   │       │   ├── Album.java
│   │   │       │   └── Photo.java
│   │   │       ├── payload
│   │   │       │   └── album
│   │   │       │       ├── AlbumPayloadDTO.java
│   │   │       │       └── AlbumViewDTO.java
│   │   │       ├── repository
│   │   │       │   ├── AlbumRepository.java
│   │   │       │   └── PhotoRepository.java
│   │   │       ├── security
│   │   │       │   └── SecurityConfig.java
│   │   │       └── service
│   │   │           └── AlbumService.java
│   │   └── resources
│   │       └── application.properties
│   └── test
│       └── java
│           └── org.studyeasy.SpringRestdemo
│               └── SpringRestdemoApplicationTests.java
├── pom.xml
└── README.md
					
				
			
		


तालिका 1: प्रोजेक्ट संरचना अवलोकन


Directory/File
विवरण


controller
HTTP अनुरोधों और प्रतिक्रियाओं को संभालता है।


model
डेटा मॉडल्स/एंटिटीज़ को परिभाषित करता है।


payload
डेटा ट्रांसफर के लिए DTOs शामिल हैं।


repository
डेटाबेस ऑपरेशन्स के लिए इंटरफेसेस।


service
व्यापार लॉजिक शामिल करता है।


security
आवेदन की सुरक्षा को प्रबंधित करता है।


config
कॉन्फ़िगरेशन फाइलें (जैसे Swagger)।


resources
आवेदन संसाधन और प्रॉपर्टीज।


test
यूनिट और इंटीग्रेशन टेस्ट्स।



Update Album API को लागू करना
प्रोजेक्ट संरचना बनाए रखने के बाद, चलिए Update Album API को लागू करने के लिए आगे बढ़ते हैं।
DTOs: डेटा ट्रांसफर ऑब्जेक्ट्स
Data Transfer Objects (DTOs) डेटा को लपेटने और यह सुनिश्चित करने के लिए महत्वपूर्ण हैं कि केवल आवश्यक जानकारी क्लाइंट को प्रकट की जाए।
AlbumPayloadDTO.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.payload.album;

public class AlbumPayloadDTO {
    private String name;
    private String description;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

	public String getDescription() {
		return description;
	}

	public void setDescription(String description) {
		this.description = description;
	}
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
				
						package org.studyeasy.SpringRestdemo.payload.album;
 
public class AlbumPayloadDTO {
    private String name;
    private String description;
 
    // Getters and Setters
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
	public String getDescription() {
		return description;
	}
 
	public void setDescription(String description) {
		this.description = description;
	}
}
 
					
				
			
		


AlbumViewDTO.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.payload.album;

import java.util.List;

public class AlbumViewDTO {
    private String name;
    private String description;
    private List<PhotoDTO> photos;

    // Getters and Setters
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

	public String getDescription() {
		return description;
	}

	public void setDescription(String description) {
		this.description = description;
	}
	
    public List<PhotoDTO> getPhotos() {
        return photos;
    }

    public void setPhotos(List<PhotoDTO> photos) {
        this.photos = photos;
    }
}

			
				
					
				
					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.payload.album;
 
import java.util.List;
 
public class AlbumViewDTO {
    private String name;
    private String description;
    private List<PhotoDTO> photos;
 
    // Getters and Setters
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
	public String getDescription() {
		return description;
	}
 
	public void setDescription(String description) {
		this.description = description;
	}
	
    public List<PhotoDTO> getPhotos() {
        return photos;
    }
 
    public void setPhotos(List<PhotoDTO> photos) {
        this.photos = photos;
    }
}
 
					
				
			
		



Controller लेयर
Controller आने वाले HTTP अनुरोधों को संभालता है और ऑपरेशन्स को Service लेयर में सौंपता है।
AlbumController.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.controller;

import org.studyeasy.SpringRestdemo.payload.album.AlbumPayloadDTO;
import org.studyeasy.SpringRestdemo.payload.album.AlbumViewDTO;
import org.studyeasy.SpringRestdemo.service.AlbumService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/albums")
public class AlbumController {

    @Autowired
    private AlbumService albumService;

    /**
     * एक मौजूदा एल्बम को अपडेट करें।
     *
     * @param albumId अपडेट करने के लिए एल्बम की ID।
     * @param payload नए एल्बम डेटा।
     * @return अपडेट किए गए एल्बम विवरण।
     */
    @PutMapping("/{albumId}/action")
    public ResponseEntity<AlbumViewDTO> updateAlbum(
            @PathVariable Long albumId,
            @RequestBody AlbumPayloadDTO payload) {
        AlbumViewDTO updatedAlbum = albumService.updateAlbum(albumId, payload);
        return new ResponseEntity<>(updatedAlbum, HttpStatus.NO_CONTENT);
    }
}

			
				
					
				
					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.controller;
 
import org.studyeasy.SpringRestdemo.payload.album.AlbumPayloadDTO;
import org.studyeasy.SpringRestdemo.payload.album.AlbumViewDTO;
import org.studyeasy.SpringRestdemo.service.AlbumService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
 
@RestController
@RequestMapping("/albums")
public class AlbumController {
 
    @Autowired
    private AlbumService albumService;
 
    /**
     * एक मौजूदा एल्बम को अपडेट करें।
     *
     * @param albumId अपडेट करने के लिए एल्बम की ID।
     * @param payload नए एल्बम डेटा।
     * @return अपडेट किए गए एल्बम विवरण।
     */
    @PutMapping("/{albumId}/action")
    public ResponseEntity<AlbumViewDTO> updateAlbum(
            @PathVariable Long albumId,
            @RequestBody AlbumPayloadDTO payload) {
        AlbumViewDTO updatedAlbum = albumService.updateAlbum(albumId, payload);
        return new ResponseEntity<>(updatedAlbum, HttpStatus.NO_CONTENT);
    }
}
 
					
				
			
		


व्याख्या:

EndPoint: PUT /albums/{albumId}/action
Parameters:

albumId: अपडेट करने के लिए एल्बम की ID।
payload: एल्बम के लिए नया डेटा।


Response: 204 No Content स्थिति के साथ अपडेट किए गए एल्बम विवरण लौटाता है।


Service लेयर
Service लेयर अपडेट ऑपरेशन को प्रोसेस करने के लिए व्यापार लॉजिक को शामिल करता है।
AlbumService.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.service;

import org.studyeasy.SpringRestdemo.model.Album;
import org.studyeasy.SpringRestdemo.payload.album.AlbumPayloadDTO;
import org.studyeasy.SpringRestdemo.payload.album.AlbumViewDTO;
import org.studyeasy.SpringRestdemo.repository.AlbumRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import org.springframework.web.server.ResponseStatusException;

import java.util.Optional;
import java.util.stream.Collectors;

@Service
public class AlbumService {

    @Autowired
    private AlbumRepository albumRepository;

    /**
     * दिए गए ID के साथ एल्बम को अपडेट करता है और प्रदान किए गए payload का उपयोग करता है।
     *
     * @param albumId अपडेट करने के लिए एल्बम की ID।
     * @param payload नए एल्बम डेटा।
     * @return अपडेट किए गए एल्बम विवरण।
     */
    public AlbumViewDTO updateAlbum(Long albumId, AlbumPayloadDTO payload) {
        Optional<Album> optionalAlbum = albumRepository.findById(albumId);

        if (!optionalAlbum.isPresent()) {
            throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Album not found");
        }

        Album album = optionalAlbum.get();

        // मान लें कि हमारे पास वर्तमान में लॉग इन किए हुए उपयोगकर्ता को प्राप्त करने का तरीका है
        String currentUser = getCurrentLoggedInUser();

        // जांचें कि वर्तमान उपयोगकर्ता एल्बम का मालिक है
        if (!album.getOwner().equals(currentUser)) {
            throw new ResponseStatusException(HttpStatus.FORBIDDEN, "You are not the owner of this album");
        }

        // एल्बम विवरण अपडेट करें
        album.setName(payload.getName());
        album.setDescription(payload.getDescription());

        // अपडेट किए गए एल्बम को सहेजें
        albumRepository.save(album);

        // AlbumViewDTO में कन्वर्ट करें
        AlbumViewDTO viewDTO = new AlbumViewDTO();
        viewDTO.setName(album.getName());
        viewDTO.setDescription(album.getDescription());
        viewDTO.setPhotos(album.getPhotos().stream()
                .map(photo -> {
                    PhotoDTO photoDTO = new PhotoDTO();
                    photoDTO.setUrl(photo.getUrl());
                    photoDTO.setDescription(photo.getDescription());
                    return photoDTO;
                })
                .collect(Collectors.toList()));
        
        return viewDTO;
    }

    /**
     * वर्तमान में लॉग इन किए हुए उपयोगकर्ता का उपयोगकर्ता नाम प्राप्त करता है।
     *
     * @return उपयोगकर्ता नाम।
     */
    private String getCurrentLoggedInUser() {
        // वर्तमान उपयोगकर्ता को प्राप्त करने के लिए कार्यान्वयन
        return "currentUser"; // प्लेसहोल्डर
    }
}

			
				
					
				
					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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
				
						package org.studyeasy.SpringRestdemo.service;
 
import org.studyeasy.SpringRestdemo.model.Album;
import org.studyeasy.SpringRestdemo.payload.album.AlbumPayloadDTO;
import org.studyeasy.SpringRestdemo.payload.album.AlbumViewDTO;
import org.studyeasy.SpringRestdemo.repository.AlbumRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Service;
import org.springframework.web.server.ResponseStatusException;
 
import java.util.Optional;
import java.util.stream.Collectors;
 
@Service
public class AlbumService {
 
    @Autowired
    private AlbumRepository albumRepository;
 
    /**
     * दिए गए ID के साथ एल्बम को अपडेट करता है और प्रदान किए गए payload का उपयोग करता है।
     *
     * @param albumId अपडेट करने के लिए एल्बम की ID।
     * @param payload नए एल्बम डेटा।
     * @return अपडेट किए गए एल्बम विवरण।
     */
    public AlbumViewDTO updateAlbum(Long albumId, AlbumPayloadDTO payload) {
        Optional<Album> optionalAlbum = albumRepository.findById(albumId);
 
        if (!optionalAlbum.isPresent()) {
            throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Album not found");
        }
 
        Album album = optionalAlbum.get();
 
        // मान लें कि हमारे पास वर्तमान में लॉग इन किए हुए उपयोगकर्ता को प्राप्त करने का तरीका है
        String currentUser = getCurrentLoggedInUser();
 
        // जांचें कि वर्तमान उपयोगकर्ता एल्बम का मालिक है
        if (!album.getOwner().equals(currentUser)) {
            throw new ResponseStatusException(HttpStatus.FORBIDDEN, "You are not the owner of this album");
        }
 
        // एल्बम विवरण अपडेट करें
        album.setName(payload.getName());
        album.setDescription(payload.getDescription());
 
        // अपडेट किए गए एल्बम को सहेजें
        albumRepository.save(album);
 
        // AlbumViewDTO में कन्वर्ट करें
        AlbumViewDTO viewDTO = new AlbumViewDTO();
        viewDTO.setName(album.getName());
        viewDTO.setDescription(album.getDescription());
        viewDTO.setPhotos(album.getPhotos().stream()
                .map(photo -> {
                    PhotoDTO photoDTO = new PhotoDTO();
                    photoDTO.setUrl(photo.getUrl());
                    photoDTO.setDescription(photo.getDescription());
                    return photoDTO;
                })
                .collect(Collectors.toList()));
        
        return viewDTO;
    }
 
    /**
     * वर्तमान में लॉग इन किए हुए उपयोगकर्ता का उपयोगकर्ता नाम प्राप्त करता है।
     *
     * @return उपयोगकर्ता नाम।
     */
    private String getCurrentLoggedInUser() {
        // वर्तमान उपयोगकर्ता को प्राप्त करने के लिए कार्यान्वयन
        return "currentUser"; // प्लेसहोल्डर
    }
}
 
					
				
			
		


व्याख्या:

मान्यकरण: जांचता है कि एल्बम मौजूद है या नहीं। अगर नहीं, तो 404 Not Found त्रुटि फेंकता है।
प्राधिकरण: सत्यापित करता है कि वर्तमान उपयोगकर्ता मालिक है या नहीं। अगर नहीं, तो 403 Forbidden त्रुटि फेंकता है।
अपडेट ऑपरेशन: एल्बम का नाम और विवरण अपडेट करता है।
पर्सिस्टेंस: अपडेट किए गए एल्बम को Repository में सहेजता है।
Response Mapping: Album एंटिटी को AlbumViewDTO में बदलता है ताकि क्लाइंट को भेजा जा सके।


Repository लेयर
Repository इंटरफेसेस डेटा पर्सिस्टेंस और रिट्रीव को संभालते हैं।
AlbumRepository.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.repository;

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

@Repository
public interface AlbumRepository extends JpaRepository<Album, Long> {
    // अतिरिक्त क्वेरी मेथड यहाँ परिभाषित किए जा सकते हैं
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
				
						package org.studyeasy.SpringRestdemo.repository;
 
import org.studyeasy.SpringRestdemo.model.Album;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
 
@Repository
public interface AlbumRepository extends JpaRepository<Album, Long> {
    // अतिरिक्त क्वेरी मेथड यहाँ परिभाषित किए जा सकते हैं
}
 
					
				
			
		



Model लेयर
डेटा मॉडल्स को परिभाषित करना डेटाबेस एंटिटीज़ को एप्लिकेशन ऑब्जेक्ट्स के साथ मैप करने के लिए आवश्यक है।
Album.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.model;

import javax.persistence.*;
import java.util.List;

@Entity
public class Album {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;
    private String description;
    private String owner;

    @OneToMany(mappedBy = "album", cascade = CascadeType.ALL)
    private List<Photo> photos;

    // Getters and Setters
    // ...
}

			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
				
						package org.studyeasy.SpringRestdemo.model;
 
import javax.persistence.*;
import java.util.List;
 
@Entity
public class Album {
 
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
 
    private String name;
    private String description;
    private String owner;
 
    @OneToMany(mappedBy = "album", cascade = CascadeType.ALL)
    private List<Photo> photos;
 
    // Getters and Setters
    // ...
}
 
					
				
			
		


Photo.java




		
		
			
			
Java
			
			package org.studyeasy.SpringRestdemo.model;

import javax.persistence.*;

@Entity
public class Photo {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String url;
    private String description;

    @ManyToOne
    @JoinColumn(name = "album_id")
    private Album album;

    // Getters and Setters
    // ...
}

			
				
					
				
					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.model;
 
import javax.persistence.*;
 
@Entity
public class Photo {
 
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
 
    private String url;
    private String description;
 
    @ManyToOne
    @JoinColumn(name = "album_id")
    private Album album;
 
    // Getters and Setters
    // ...
}
 
					
				
			
		


व्याख्या:

Album: एल्बम एंटिटी का प्रतिनिधित्व करता है जिसमें id, name, description, और owner जैसे गुण शामिल हैं। इसका Photo के साथ एक-से-कई रिलेशनशिप है।
Photo: एल्बम से संबंधित फोटो एंटिटी का प्रतिनिधित्व करता है। प्रत्येक फोटो का url और description होता है।


सुरक्षा और प्राधिकरण
सुनिश्चित करना कि केवल अधिकृत उपयोगकर्ता ही अपडेट ऑपरेशन्स को अंजाम दे सकें, अत्यंत महत्वपूर्ण है। Spring Security सुरक्षा उपायों को लागू करने के लिए एक मजबूत फ्रेमवर्क प्रदान करता है।
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.*;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        // डेमोंस्ट्रेशन के लिए इन-मेमोरी ऑथेंटिकेशन सेटअप
        auth.inMemoryAuthentication()
            .withUser("currentUser").password("{noop}password").roles("USER");
    }

    @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
				
						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.*;
 
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
 
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        // डेमोंस्ट्रेशन के लिए इन-मेमोरी ऑथेंटिकेशन सेटअप
        auth.inMemoryAuthentication()
            .withUser("currentUser").password("{noop}password").roles("USER");
    }
 
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .csrf().disable()
            .authorizeRequests()
                .antMatchers("/albums/**").authenticated()
                .and()
            .httpBasic();
    }
}
 
					
				
			
		


व्याख्या:

Authentication: एक उपयोगकर्ता नाम currentUser के साथ इन-मेमोरी ऑथेंटिकेशन सेटअप करता है।
Authorization: /albums/** के तहत सभी एंडपॉइंट्स के लिए ऑथेंटिकेशन की आवश्यकता होती है।
HTTP Basic: सरलता के लिए HTTP Basic का उपयोग करता है। उत्पादन में, JWT जैसे अधिक सुरक्षित तरीकों पर विचार करें।


Update Album API का परीक्षण
परीक्षण यह सुनिश्चित करता है कि API अपेक्षित रूप से कार्य करता है और विभिन्न परिदृश्यों को सहजता से संभालता है।
अपडेट ऑपरेशन्स को अंजाम देना

एक नया एल्बम जोड़ें:

Endpoint: POST /albums
Payload:

        



		
		
			
			
Java
			
			{
  "name": "Travel",
  "description": "Summer vacation photos"
}
			
				
					
				
					1
2
3
4
				
						{
  "name": "Travel",
  "description": "Summer vacation photos"
}
					
				
			
		


      
Response: 201 Created


एल्बम में फोटो जोड़ें:

Endpoint: POST /albums/2/photos
Payload:

        



		
		
			
			
Java
			
			{
  "url": "http://example.com/photo1.jpg",
  "description": "Beach view"
}
			
				
					
				
					1
2
3
4
				
						{
  "url": "http://example.com/photo1.jpg",
  "description": "Beach view"
}
					
				
			
		


      
Response: 201 Created


एल्बम विवरण को अपडेट करें:

Endpoint: PUT /albums/2/action
Payload:

        



		
		
			
			
Java
			
			{
  "name": "New Travel Album",
  "description": "Updated description"
}
			
				
					
				
					1
2
3
4
				
						{
  "name": "New Travel Album",
  "description": "Updated description"
}
					
				
			
		


      
Response: 204 No Content


अपडेट को सत्यापित करें:

Endpoint: GET /albums/2
Response:

        



		
		
			
			
Java
			
			{
  "name": "New Travel Album",
  "description": "Updated description",
  "photos": [
    {
      "url": "http://example.com/photo1.jpg",
      "description": "Beach view"
    }
  ]
}
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
				
						{
  "name": "New Travel Album",
  "description": "Updated description",
  "photos": [
    {
      "url": "http://example.com/photo1.jpg",
      "description": "Beach view"
    }
  ]
}
					
				
			
		


      



व्याख्या:

Adding Albums and Photos: अपडेट ऑपरेशन का परीक्षण करने के लिए प्रारंभिक डेटा सेटअप करता है।
Updating Album: एल्बम का नाम और विवरण बदलता है।
Verification: सुनिश्चित करता है कि अपडेट सफलतापूर्वक लागू हुआ है।


निष्कर्ष
Update Album API को Spring REST का उपयोग करके लागू करना कई मुख्य घटकों को शामिल करता है, जिनमें DTOs, Controllers, Services, Repositories, और सुरक्षा कॉन्फ़िगरेशन्स शामिल हैं। एक संरचित दृष्टिकोण का पालन करके और सर्वोत्तम प्रथाओं का अनुपालन करते हुए, डेवलपर्स मजबूत और सुरक्षित APIs बना सकते हैं जो उनके अनुप्रयोगों की कार्यक्षमता को बढ़ाते हैं।
मुख्य निष्कर्ष:

DTOs महत्वपूर्ण हैं: वे डेटा की अखंडता सुनिश्चित करते हैं और क्लाइंट और सर्वर के बीच सूचना प्रवाह को नियंत्रित करते हैं।
श्रृंखलाबद्ध आर्किटेक्चर: Controllers, Services, और Repositories में चिंताओं को अलग करने से रखरखाव में सुधार होता है।
सुरक्षा अत्यंत महत्वपूर्ण है: सही प्राधिकरण जांचें बिना अधिकृत ऑपरेशन्स को रोकती हैं और उपयोगकर्ता डेटा की रक्षा करती हैं।
थोरो परीक्षण: नियमित परीक्षण यह सुनिश्चित करता है कि APIs अपेक्षित रूप से व्यवहार करते हैं और किनारे के मामलों को प्रभावी ढंग से संभालते हैं।

Spring REST के साथ APIs बनाने की यात्रा डेवलपर्स को स्केलेबल और कुशल वेब सेवाओं को बनाने के लिए उपकरण और ज्ञान प्रदान करती है। जैसे-जैसे आप अधिक APIs का अन्वेषण और कार्यान्वयन जारी रखते हैं, इस गाइड में कवर किए गए बुनियादी अवधारणाएँ एक मूल्यवान संदर्भ के रूप में काम करेंगी।
SEO Keywords: Spring REST, Update Album API, Spring Boot tutorial, RESTful API development, Spring Security, Java API development, Album management API, Spring Boot REST controller, DTO in Spring, API authorization, Spring Boot project setup
Note: This article is AI generated.
Directory/File	विवरण
`controller`	HTTP अनुरोधों और प्रतिक्रियाओं को संभालता है।
`model`	डेटा मॉडल्स/एंटिटीज़ को परिभाषित करता है।
`payload`	डेटा ट्रांसफर के लिए DTOs शामिल हैं।
`repository`	डेटाबेस ऑपरेशन्स के लिए इंटरफेसेस।
`service`	व्यापार लॉजिक शामिल करता है।
`security`	आवेदन की सुरक्षा को प्रबंधित करता है।
`config`	कॉन्फ़िगरेशन फाइलें (जैसे Swagger)।
`resources`	आवेदन संसाधन और प्रॉपर्टीज।
`test`	यूनिट और इंटीग्रेशन टेस्ट्स।