SNS 애플리케이션용 REST API 설계하기

Soo·2024년 3월 23일

주요 도메인

  • Users
  • Posts

주요 상세정보

  • User: id, name, birthDate
  • Post: id, description

REST API 설계에 앞서 HTTP Method에 대해 간략하게 알아보겠습니다.

  • GET - 자원을 조회할 때 사용합니다.
  • POST - 자원을 생성할 때 사용합니다.
  • PUT - 자원을 전체 수정할 때 사용합니다.
  • PATCH - 일부 자원을 수정할 때 사용합니다.
  • DELETE - 자원을 삭제할 때 사용합니다.

이제 간략하게 HTTP Method에 대해 알아봤으니 Users, Post API 설계를 하겠습니다.

Users

  • 전체 조회
    • GEt /users
  • 생성 기능
    • POST /users
  • 사용자 단건 조회
    • GET /users/{id} → users/1
  • 삭제 기능
    • DELETE /users/{id} → users/1

Posts

중요한점은 게시물은 사용자와 연결되어 있다는 것입니다. 사용자가 게시물을 만들기 때문이죠.

  • 특정 유저가 생성한 게시물 전체 조회 (Users의 사용자 단건 조회를 사용해서 URL을 만들겠습니다)
    • GET /users/{id}/posts → users/1/posts
  • 생성 기능
    • POST /users/{id}/posts → users/1/posts
  • 게시물 상세 조회
    • GET /users/{id}/posts/{post_id} → users/1/posts/1

0개의 댓글