Spring Rest API 설계 - GET

 

REST

- 전에 적었던 RestController의 Rest와는 다른의미.

- REST란 주소에 명사, 요청 방식에 동사를 사용함으로써 의도를 명확히 드러냄을 의미합니다.

- 여기에 쓰이는 동사는 우리가 JPA 시간에 배운 CRUD를 지칭.

- 즉 A에 대해 생성(POST)/조회(GET)/수정(PUT)/삭제(DELETE) 요청을 하는 것

Example

• GET /courses → 강의 전체 목록 조회 요청
• GET /courses/1 → ID가 1번인 녀석 조회 요청
• POST /courses → 강의 생성 요청
• PUT /courses/3 → ID가 3번인 녀석 수정 요청
• DELETE /courses/2 → ID 2번인 녀석 삭제 요청

주의사항

• 주소에 들어가는 명사들은 복수형을 사용합니다.
  • /course (courses 사용)
• 주소에 동사는 가급적 사용하지 않습니다.
  • /accounts/edit (edit 대신 put 사용)

 

CourseController 생성

1. 패키지 생성

 

2. CourseController 생성

@RequiredArgsConstructor
@RestController
public class CourseController {

    private final CourseRepository courseRepository;

    @GetMapping("/api/courses")
    public List<Course> getCourses() {
        return courseRepository.findAll();
    }
}

 

3. ARC로 확인 (POSTMAN 도 가능)