[REST API] SNS 어플리케이션용 REST API 설계하기

민지·2024년 3월 10일
0

REST API - Spring Boot

목록 보기
5/27

Hello World REST API로 REST API에 대한 간단한 내용을 배웠으니, 이번에는 SNS 어플리케이션용 REST API를 빌드시켜보겠다.

1. SNS 어플리케이션 REST API에서 만들 것들

2가지 resources - user와 post

두 가지 중요한 resource들은 user와 post(게시글)이다.

또한, 각 user와 post에는 다음의 상세정보들을 저장해야 한다.

  • user - id, name, brithDate
  • post - id, description

request methods for REST API

user와 post 모두 delete, update, add, create 같은 기능들을 수행해야 한다.

REST API를 사용해, 어떻게 이와 같은 기능을 수행할 수 있을까? - REST API의 Respest Method를 이용하면 된다!

  • GET - Retrieve details of a resource
  • POST - Create a new resource
  • PUT - Update an existing resource
  • PATCH - Update part of a resource
    -> ex) 특정 사용자 생일만 update하고 싶을 때
  • DELETE - Delete a resource

2. SNS 어플리케이션 REST API 구조를 설계해보자!

  • Retrieve all Users - GET /users

  • Create a User - POST /users

  • Retrieve one User - GET /users/{id} -> /users/1

  • Delete a User - DELETE /users/{id} -> /users/1

  • Retrieve all posts for a User - GET /users/{id}/posts

  • Create a posts for a User - POST /users/{id}/posts

  • Retrieve details of a post - GET /users/{id}/posts/{post_id}

URL 설계할 때, users인지 a user인지 애초에 설계할 때 잘 구분지을 것!

참고 및 출처

이 시리즈는 Udemy 강의의 내용을 정리한 것입니다.
https://www.udemy.com/course/spring-boot-and-spring-framework-korean/

profile
배운 내용을 바로바로 기록하자!

0개의 댓글