Korean Dummy JSON

📃 목차 (클릭 시 해당 목차로 이동합니다.)

• 👋 프로젝트 소개

• ⚙ 개발환경

• 📚 제공 리소스

• ✨ 사용 예시 코드

• 📖 Pagination Endpoints

• 🗜 Filter Endpoints

• ⛓ Nested Endpoints

• 📜 All API Endpoints

👋 프로젝트 소개

Korean Dummy JSON은 한국어 기반의 더미 데이터를 제공하기 위해 제작된 프로젝트로, JSONPlaceholder에 영감을 받아 개발되었습니다.

한국어로 구성된 데이터를 통해 개발자들이 보다 현실적인 더미 데이터를 제공 받을 수 있습니다.

추가로 JWT 기반 로그인 및 인증/인가 더미 API 및 동적 더미 이미지 생성 API가 제공됩니다.

가입할 필요없이 간편하게 바로 사용할 수 있습니다.

GET, POST, PUT, PATCH, DELETE 요청을 보내고 직접 테스트 해보고 학습해 보세요.

📅 개발 기간 : 2024. 08. 27. ~ 2024. 09. 14.

🔗 배포 URL : 📚 Korean Dummy JSON

⚠ 현재 프로젝트는 무료 DB 서버를 사용하고 있어, 일시적으로 API 요청이 중단될 수 있습니다.

⚙ 개발환경

프론트엔드	벡엔드	DB	디자인	배포, 관리

📚 제공 리소스

users, posts, comments, todos, books, reviews, auth 7개의 리소스가 제공됩니다.

Resource	Information
/users	유저 20명
/posts	게시물 100개
/comments	댓글 500개
/todos	할 일 200개
/books	책 100개
/reviews	리뷰 500개
/auth	로그인 및 인증/인가
/image	동적 더미 이미지 생성

✨ 사용 예시 코드

예시 코드에서는 Fetch API를 사용합니다.

각 예시 코드를 복사한 후 브라우저 콘솔에서 실행해 보세요.

자세한 사용법을 알고 싶으시면 리소스별 📃Docs 페이지를 참고해 주세요.

1 ) 데이터 조회하기

fetch("https://koreandummyjson.site/api/posts/1")
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 조회 성공",
  "post": {
    "id": 1,
    "title": "서울의 숨겨진 명소",
    "content": "서울에는 잘 알려지지 않은 멋진 명소가 많다. 최근에 방문한 작은 카페와 조용한 공원이 특히 기억에 남는다. 이곳은 복잡한 도시를 벗어나 평화로운 시간을 보낼 수 있는 완벽한 장소였다. 특히, 따뜻한 차와 함께 창밖을 바라보며 책을 읽는 시간이 정말 행복했다.",
    "imgUrl": "https://picsum.photos/id/1/300/300",
    "createdAt": "2024-01-01T08:00:00.000Z",
    "userId": 1
  }
}

2 ) 데이터 목록 조회하기

fetch("https://koreandummyjson.site/api/posts")
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 목록 조회 성공",
  "posts": [
    {
      "id": 1,
      "title": "서울의 숨겨진 명소",
      "content": "서울에는 잘 알려지지 않은 멋진 명소가 많다. 최근에 방문한 작은 카페와 조용한 공원이 특히 기억에 남는다. 이곳은 복잡한 도시를 벗어나 평화로운 시간을 보낼 수 있는 완벽한 장소였다. 특히, 따뜻한 차와 함께 창밖을 바라보며 책을 읽는 시간이 정말 행복했다.",
      "imgUrl": "https://picsum.photos/id/1/300/300",
      "createdAt": "2024-01-01T08:00:00.000Z",
      "userId": 1
    },
    {
      "id": 2,
      "title": "여름 바다의 매력",
      "content": "여름이 다가오면서 바다를 찾는 사람들로 가득하다. 바닷가에서의 하루는 언제나 특별하다. 모래사장 위를 걷고, 파도 소리를 들으며, 시원한 바람을 맞는 순간들은 잊을 수 없는 기억이 된다. 특히, 일몰 때 바다를 바라보며 찍은 사진은 너무 아름다웠다.",
      "imgUrl": "https://picsum.photos/id/2/300/300",
      "createdAt": "2024-01-03T09:00:00.000Z",
      "userId": 2
    },
    ...
  ]
}

3 ) 데이터 페이지네이션

fetch("https://koreandummyjson.site/api/posts?page=1&limit=10")
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 목록 조회 성공",
  "posts": [
    {
      "id": 1,
      "title": "서울의 숨겨진 명소",
      "content": "서울에는 잘 알려지지 않은 멋진 명소가 많다. 최근에 방문한 작은 카페와 조용한 공원이 특히 기억에 남는다. 이곳은 복잡한 도시를 벗어나 평화로운 시간을 보낼 수 있는 완벽한 장소였다. 특히, 따뜻한 차와 함께 창밖을 바라보며 책을 읽는 시간이 정말 행복했다.",
      "imgUrl": "https://picsum.photos/id/1/300/300",
      "createdAt": "2024-01-01T08:00:00.000Z",
      "userId": 1
    },
    {
      "id": 2,
      "title": "여름 바다의 매력",
      "content": "여름이 다가오면서 바다를 찾는 사람들로 가득하다. 바닷가에서의 하루는 언제나 특별하다. 모래사장 위를 걷고, 파도 소리를 들으며, 시원한 바람을 맞는 순간들은 잊을 수 없는 기억이 된다. 특히, 일몰 때 바다를 바라보며 찍은 사진은 너무 아름다웠다.",
      "imgUrl": "https://picsum.photos/id/2/300/300",
      "createdAt": "2024-01-03T09:00:00.000Z",
      "userId": 2
    },
    ...
  ],
  "page": 1,
  "limit": 10,
  "hasNextPage": true
}

4 ) 데이터 생성하기

fetch("https://koreandummyjson.site/api/posts", {
  method: "POST",
  body: JSON.stringify({
    title: "테스트 글",
    content: "테스트 글 입니다.",
    imgUrl: "https://picsum.photos/id/1/300/300",
    userId: 1
  }),
  headers: {
    "Content-Type": "application/json"
  }
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 생성 성공",
  "post": {
    "id": 101,
    "title": "테스트 글",
    "content": "테스트 글 입니다.",
    "imgUrl": "https://picsum.photos/id/1/300/300",
    "createdAt": "2024-09-07T16:09:43.814Z",
    "userId": 1
  }
}

5 ) 데이터 수정하기(PUT)

fetch("https://koreandummyjson.site/api/posts/1", {
  method: "PUT",
  body: JSON.stringify({
    title: "테스트 글",
    contnet: "테스트 글 입니다.",
    imgUrl: "https://picsum.photos/id/2/300/300"
  }),
  headers: {
    "Content-Type": "application/json"
  }
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 수정 성공",
  "post": {
    "id": 1,
    "title": "테스트 글",
    "imgUrl": "https://picsum.photos/id/2/300/300",
    "createdAt": "2024-01-01T08:00:00.000Z",
    "userId": 1
  }
}

6 ) 데이터 수정하기(PATCH)

fetch("https://koreandummyjson.site/api/posts/1", {
  method: "PATCH",
  body: JSON.stringify({
    title: "테스트 글"
  }),
  headers: {
    "Content-Type": "application/json"
  }
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 수정 성공",
  "post": {
    "id": 1,
    "title": "테스트 글",
    "content": "서울에는 잘 알려지지 않은 멋진 명소가 많다. 최근에 방문한 작은 카페와 조용한 공원이 특히 기억에 남는다. 이곳은 복잡한 도시를 벗어나 평화로운 시간을 보낼 수 있는 완벽한 장소였다. 특히, 따뜻한 차와 함께 창밖을 바라보며 책을 읽는 시간이 정말 행복했다.",
    "imgUrl": "https://picsum.photos/id/1/300/300",
    "createdAt": "2024-01-01T08:00:00.000Z",
    "userId": 1
  }
}

7 ) 데이터 삭제하기

fetch("https://koreandummyjson.site/api/posts/1", {
  method: "DELETE"
})
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "1번 게시물 삭제 성공"
}

8 ) 데이터 필터링하기

fetch("https://koreandummyjson.site/api/posts/?userId=1")
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
  "message": "게시물 목록 조회 성공",
  "posts": [
    {
      "id": 1,
      "title": "서울의 숨겨진 명소",
      "content": "서울에는 잘 알려지지 않은 멋진 명소가 많다. 최근에 방문한 작은 카페와 조용한 공원이 특히 기억에 남는다. 이곳은 복잡한 도시를 벗어나 평화로운 시간을 보낼 수 있는 완벽한 장소였다. 특히, 따뜻한 차와 함께 창밖을 바라보며 책을 읽는 시간이 정말 행복했다.",
      "imgUrl": "https://picsum.photos/id/1/300/300",
      "createdAt": "2024-01-01T08:00:00.000Z",
      "userId": 1
    },
    {
      "id": 21,
      "title": "여행의 추억",
      "content": "여행 중 촬영한 사진들을 보며 그때의 추억이 새록새록 떠오른다. 특히, 그 지역의 아름다운 풍경과 현지 음식들은 잊을 수 없는 경험이었다. 여행을 통해 얻은 소중한 기억들을 계속 간직하고 싶다.",
      "imgUrl": "https://picsum.photos/id/21/300/300",
      "createdAt": "2024-04-11T12:00:00.000Z",
      "userId": 1
    },
    {
      "id": 41,
      "title": "서울의 명소 탐방",
      "content": "서울의 다양한 명소를 탐방하는 것은 언제나 즐거운 일이다. 오늘은 남산타워를 방문하여 서울의 전경을 감상하고, 맛있는 음식을 즐기며 좋은 시간을 보냈다.",
      "imgUrl": "https://picsum.photos/id/41/300/300",
      "createdAt": "2024-07-05T16:00:00.000Z",
      "userId": 1
    },
    {
      "id": 61,
      "title": "서울의 역사 탐방",
      "content": "서울의 역사를 탐방하는 것은 흥미로운 경험이다. 오늘은 서울의 고궁을 방문하여 역사의 흔적을 느꼈다. 과거와 현재가 만나는 장소에서 많은 것을 배웠다.",
      "imgUrl": "https://picsum.photos/id/61/300/300",
      "createdAt": "2024-08-11T18:00:00.000Z",
      "userId": 1
    },
    {
      "id": 81,
      "title": "가을의 풍경",
      "content": "가을이 깊어지면서 자연이 황금빛으로 물들어 간다. 오늘은 공원에서 노란 은행나무를 보며 가을의 정취를 만끽했다. 이런 순간들이 가을을 더욱 특별하게 만든다.",
      "imgUrl": "https://picsum.photos/id/81/300/300",
      "createdAt": "2024-09-10T08:00:00.000Z",
      "userId": 1
    }
  ]
}

9 ) 중첩 하위 데이터 조회하기

fetch("https://koreandummyjson.site/api/posts/1/comments")
  .then((response) => response.json())
  .then((data) => console.log(data))
  .catch((error) => console.error("Error fetching data:", error));

결과

{
{
  "message": "게시물 댓글 목록 조회 성공",
  "comments": [
    {
      "id": 1,
      "commentId": 1,
      "content": "정말 유익한 게시물입니다!",
      "createdAt": "2024-04-11T12:01:00.000Z"
    },
    {
      "id": 1,
      "commentId": 2,
      "content": "좋은 정보 감사합니다.",
      "createdAt": "2024-04-11T12:03:00.000Z"
    },
    {
      "id": 1,
      "commentId": 3,
      "content": "이 주제에 대해 더 알고 싶어요.",
      "createdAt": "2024-04-11T12:06:00.000Z"
    },
    {
      "id": 1,
      "commentId": 4,
      "content": "도움이 많이 되었어요.",
      "createdAt": "2024-04-11T12:10:00.000Z"
    },
    {
      "id": 1,
      "commentId": 5,
      "content": "잘 읽었습니다.",
      "createdAt": "2024-04-11T12:15:00.000Z"
    }
  ]
}
}

📖 Pagination Endpoints

아래와 같은 페이지네이션 endpoints를 제공합니다.

Endpoint	Method	Action
/users?page={page}&limit={limit}	GET	유저 목록 페이징
/todos?page={page}&limit={limit}	GET	할 일 목록 페이징
/posts?page={page}&limit={limit}	GET	게시물 목록 페이징
/comments?page={page}&limit={limit}	GET	댓글 목록 페이징
/books?page={page}&limit={limit}	GET	책 목록 페이징
/reviews?page={page}&limit={limit}	GET	리뷰 목록 페이징

🗜 Filter Endpoints

아래와 같은 필터링 endpoints를 제공합니다.

Endpoint	Method	Action
/todos?userId={userId}	GET	유저별 할 일 목록
/comments?userId={userId}	GET	유저별 댓글 목록
/comments?postId={postId}	GET	게시물별 댓글 목록
/reviews?bookId={bookId}	GET	책별 리뷰 목록
/reviews?userId={userId}	GET	유저별 리뷰 목록

⛓ Nested Endpoints

아래와 같은 하위 endpoints를 제공합니다.

Endpoint	Method	Action
/users/:id/todos	GET	유저별 할 일 목록 조회
/users/:id/posts	GET	유저별 게시물 목록 조회
/users/:id/comment	GET	유저별 댓글 목록 조회
/users/:id/reviews	GET	유저별 리뷰 목록 조회
/posts/:id/comments	GET	게시물별 댓글 목록 조회
/books/:id/reviews	GET	책별 리뷰 목록 조회

📜 All API Endpoints

Endpoint	Method	Action
/users/:id	GET	유저 조회
/users	GET	유저 목록
/users?page={page}&limit={limit}	GET	유저 목록 페이지
/users/:id/todos	GET	유저 할 일 목록 조회
/users/:id/posts	GET	유저 게시물 목록 조회
/users/:id/comments	GET	유저 댓글 목록 조회
/users/:id/books	GET	유저 책 목록 조회
/users/:id/reviews	GET	유저 리뷰 목록 조회
/users	POST	유저 생성
/users/:id	PUT	유저 수정
/users/:id	PATCH	유저 수정
/users/:id	DELETE	유저 삭제
/todos/:id	GET	할 일 조회
/todos	GET	할 일 목록
/todos?userId={userId}	GET	유저 할 일 목록 필터링
/todos?page={page}&limit={limit}	GET	할 일 목록 페이지
/todos	POST	할 일 생성
/todos/:id	PUT	할 일 수정
/todos/:id	PATCH	할 일 수정
/todos/:id	DELETE	할 일 삭제
/posts/:id	GET	게시물 조회
/posts	GET	게시물 목록
/posts?page={page}&limit={limit}	GET	게시물 목록 페이지
/posts/:id/comments	GET	게시물 댓글 목록 조회
/posts?userId={userId}	GET	유저 게시물 목록 필터링
/posts	POST	게시물 생성
/posts/:id	PUT	게시물 수정
/posts/:id	PATCH	게시물 수정
/posts/:id	DELETE	게시물 삭제
/comments/:id	GET	댓글 조회
/comments	GET	댓글 목록
/comments?page={page}&limit={limit}	GET	댓글 목록 페이지
/comments?userId={userId}	GET	유저 댓글 목록 필터링
/comments?postId={postId}	GET	게시물 댓글 목록 필터링
/comments	POST	댓글 생성
/comments/:id	PUT	댓글 수정
/comments/:id	PATCH	댓글 수정
/comments/:id	DELETE	댓글 삭제
/books/:id	GET	책 조회
/books	GET	책 목록
/books?page={page}&limit={limit}	GET	책 목록 페이지
/books/:id/reviews	GET	책 리뷰 목록 조회
/books	POST	책 생성
/books/:id	PUT	책 수정
/books/:id	PATCH	책 수정
/books/:id	DELETE	책 삭제
/reviews/:id	GET	리뷰 조회
/reviews	GET	리뷰 목록
/reviews?page={page}&limit={limit}	GET	리뷰 목록 페이지
/reviews?userId={userId}	GET	유저 리뷰 필터링
/reviews?bookId={bookId}	GET	책 리뷰 필터링
/reviews	POST	리뷰 생성
/reviews/:id	PUT	리뷰 수정
/reviews/:id	PATCH	리뷰 수정
/reviews/:id	DELETE	리뷰 삭제
/auth/login	POST	로그인
/auth/user	GET	유저 조회
/auth/refresh	GET	토큰 재발급
/image/:size/:bgColor/:text.{ext}/:textColor	GET	동적 더미 이미지 생성