[SpringBoot] 💡 여러가지 API 작성법

📘 API

API는 Application Programming Interface의 약자로 운영체제나 응용프로그램 사이의 통신에 사용되는 언어나 메세지 형식을 의미한다.
일반적으로 다음의 4가지 메서드를 주로 사용하며, 뒤에 기능으로 주로 쓰인다.

• GET - read
• POST - create
• PUT - update
• DELETE - delete

📘 Get 메서드

URL의 경로나 파라미터에 변수를 넣어서 요청을 보내는 방식이다.

    @GetMapping("/getmapping")
    public String getMapping() {
        return "getMapping";
    }

🍓 @pathVariable

    @GetMapping("/getmapping2/{variable}")
    public String getMapping2(@PathVariable String variable) {
        return variable;
    }

🍓 @RequestParam

    @GetMapping("/getmapping3")
    public String getMapping3(
            @RequestParam String name,
            @RequestParam String email,
            @RequestParam String organization) {
        return name + " " + email + " " + organization;
    }

🍓 DTO 객체

📌 dto

dto package를 만들어 준 후, dto 객체를 만들어준다.
alt + insert 단축키를 통해서 쉽게 getter & setter 와 toString을 생성가능하다.

dto 객체

package com.example.test.dto;

public class MemberDto {
    private String name;
    private String email;
    private String organization;

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

    public void setEmail(String email) {
        this.email = email;
    }

    public String getOrganization() {
        return organization;
    }

    public void setOrganization(String organization) {
        this.organization = organization;
    }

    public String getEmail() {
        return email;
    }

    public String getName() {
        return name;
    }

    @Override
    public String toString() {
        return "MemberDto{" +
                "name='" + name + '\'' +
                ", email='" + email + '\'' +
                ", organization='" + organization + '\'' +
                '}';
    }
}

    @GetMapping("/getmapping4")
    public String getmapping4(MemberDto dto){
        return dto.toString();
    }

📘 POST 메서드

저장하고자 하는 리소스나 값을 HTTP 바디(body)에 담아서 서버에 전달한다.
Body 영역에 작성되는 값은 일정한 형태를 취하는데, 일반적으로 JSON 형식으로 전송된다.

🍓 DTO 객체

@RestController
@RequestMapping("/post")
public class PostController {
    @PostMapping("/postmapping1")
    public String PostMapping(@RequestBody MemberDto dto){
        return dto.toString();
    }
}

📘 PUT 메서드

웹 애플리케이션 서버를 통해 데이터베이스 같은 저장소에 저장하는 리소스 값을 업데이트 하는데 사용한다.

🍓 DTO 객체

@RestController
@RequestMapping("/put")
public class PutController {

    @PutMapping("/putMapping1")
    public String putMapping(@RequestBody MemberDto dto){
        return dto.toString();
    }
}

📘 DELETE 메서드

웹 애플리케이션 서버를 통해 데이터베이스 같은 저장소에 저장하는 리소스 값을 업데이트 하는데 사용한다.

🍓 DTO 객체

@RestController
@RequestMapping("/put")
public class PutController {

    @PutMapping("/putMapping1")
    public String putMapping(@RequestBody MemberDto dto){
        return dto.toString();
    }
}

---

개인 공부 기록용 블로그입니다.
틀리거나 오류가 있을 경우 제보해주시면 감사하겠습니다.😁