Korean Dummy JSON Fetcher

koreanDummyJSON 프로젝트를 기반으로 만들어졌으며, 직접 비동기 API 호출 작업 없이 바로 더미 데이터를 가져올 수 있습니다.

단순 데이터 조회뿐 아니라, PATCH, PUT, POST, DELETE 등 CRUD API도 모두 지원하여 실제 REST API와 유사하게 테스트 및 개발에 활용할 수 있습니다.

자세한 API별 사용법은 DOCS를 참고해주세요.

Features

• 한국어 기반 더미 데이터를 제공합니다.
• 사용자, 할 일, 게시글, 댓글, 책, 리뷰 등 다양한 엔드포인트을 지원합니다.
• 페이지네이션 기능을 지원합니다.
• GET뿐 아니라 테스트 모킹용 PATCH, PUT, POST, DELETE 등 CRUD API를 지원합니다.
• 토큰 인증(Auth), 동적 이미지 생성(Image) API를 지원합니다.
• 한글 로렘 입숨 생성 API를 지원합니다.
• TypeScript를 지원합니다.(타입 정의 포함)
• ESM/CJS를 모두 지원합니다.
• 비동기 fetch 작업 없이 바로 더미 데이터 반환합니다.

📌 참고사항 이 라이브러리의 PATCH, PUT, POST, DELETE API는 서버의 데이터를 영구적으로 변경하지 않습니다. 요청에 대한 성공적인 모의(mock) 응답을 반환할 뿐, 실제 데이터는 원래 상태 그대로 유지됩니다.

Resources

아래 9개의 리소스를 제공합니다.

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

Installing

npm

1npm install korean-dummy-json-fetcher

yarn

1yarn add korean-dummy-json-fetcher

pnpm

1pnpm add korean-dummy-json-fetcher

CDN

unpkg

1<script src="https://unpkg.com/korean-dummy-json-fetcher@1.1.0/dist/index.min.js"></script>

jsdelivr

1<script src="https://cdn.jsdelivr.net/npm/korean-dummy-json-fetcher@1.1.0/dist/index.min.js"></script>

Usage

Users

1import {
2  getUsers,
3  getUser,
4  createUser,
5  patchUser,
6  putUser,
7  deleteUser,
8} from "korean-dummy-json-fetcher";
9
10async function fetchUsers() {
11  // 전체 유저 목록 가져오기
12  const users = await getUsers();
13  console.log(users);
14
15  // 유저 목록 페이지네이션
16  const usersPage = await getUsers({ page: 1, limit: 10 });
17  console.log(usersPage);
18
19  // 특정 유저 가져오기
20  const user = await getUser({ id: 1 });
21  console.log(user);
22
23  // 유저 생성
24  const createUserResult = await createUser({
25    username: "newuser",
26    email: "newuser@example.com",
27    phone: "010-1234-5678",
28    address: "서울시 강남구",
29  });
30  console.log(createUserResult);
31
32  // 유저 일부 수정
33  const patchResult = await patchUser(1, { username: "수정된 이름" });
34  console.log(patchResult);
35
36  // 유저 전체 수정
37  const putResult = await putUser(1, {
38    username: "수정된 이름",
39    email: "수정된 이메일",
40    phone: "010-1111-2222",
41    address: "수정된 주소",
42  });
43  console.log(putResult);
44
45  // 유저 삭제
46  const deleteResult = await deleteUser({ id: 1 });
47  console.log(deleteResult);
48}
49
50fetchUsers();

Todos

1import {
2  getTodos,
3  getTodo,
4  createTodo,
5  patchTodo,
6  putTodo,
7  deleteTodo,
8} from "korean-dummy-json-fetcher";
9
10async function fetchTodos() {
11  // 전체 할 일 목록 가져오기
12  const todos = await getTodos();
13  console.log(todos);
14
15  // 할 일 목록 페이지네이션
16  const todosPage = await getTodos({ page: 1, limit: 10 });
17  console.log(todosPage);
18
19  // 특정 유저의 할 일 목록 가져오기
20  const todosFilterUserId = await getTodos({ userId: 1 });
21  console.log(todosFilterUserId);
22
23  // 특정 할 일 가져오기
24  const todo = await getTodo({ id: 1 });
25  console.log(todo);
26
27  // 할 일 생성
28  const createTodoResult = await createTodo({
29    userId: 1,
30    content: "새로운 할 일",
31    completed: false,
32  });
33  console.log(createTodoResult);
34
35  // 할 일 일부 수정
36  const patchTodoResult = await patchTodo(1, {
37    completed: true,
38  });
39  console.log(patchTodoResult);
40
41  // 할 일 전체 수정
42  const putTodoResult = await putTodo(1, {
43    content: "수정된 할 일",
44    completed: true,
45  });
46  console.log(putTodoResult);
47
48  // 할 일 삭제
49  const deleteTodoResult = await deleteTodo({ id: 1 });
50  console.log(deleteTodoResult);
51}
52
53fetchTodos();

Posts

1import {
2  getPosts,
3  getPost,
4  createPost,
5  patchPost,
6  putPost,
7  deletePost,
8} from "korean-dummy-json-fetcher";
9
10async function fetchPosts() {
11  // 전체 게시글 목록 가져오기
12  const posts = await getPosts();
13  console.log(posts);
14
15  // 게시글 목록 페이지네이션
16  const postsPage = await getPosts({ page: 1, limit: 10 });
17  console.log(postsPage);
18
19  // 특정 유저 게시물 목록 가져오기
20  const userPosts = await getPosts({ userId: 1 });
21  console.log(userPosts);
22
23  // 특정 게시글 가져오기
24  const post = await getPost({ id: 1 });
25  console.log(post);
26
27  // 게시글 생성
28  const createPostResult = await createPost({
29    userId: 1,
30    title: "새 게시글",
31    content: "게시글 내용",
32    imgUrl: "https://example.com/image.png",
33  });
34  console.log(createPostResult);
35
36  // 게시글 일부 수정
37  const patchPostResult = await patchPost(1, { title: "수정된 게시글" });
38  console.log(patchPostResult);
39
40  // 게시글 전체 수정
41  const putPostResult = await putPost(1, {
42    title: "수정된 게시글",
43    content: "수정된 내용",
44    imgUrl: "https://resource.com/image.png",
45  });
46  console.log(putPostResult);
47
48  // 게시글 삭제
49  const deletePostResult = await deletePost({ id: 1 });
50  console.log(deletePostResult);
51}
52
53fetchPosts();

Comments

1import {
2  getComments,
3  getComment,
4  createComment,
5  patchComment,
6  putComment,
7  deleteComment,
8} from "korean-dummy-json-fetcher";
9
10async function fetchComments() {
11  // 전체 댓글 목록 가져오기
12  const comments = await getComments();
13  console.log(comments);
14
15  // 댓글 목록 페이지네이션
16  const commentsPage = await getComments({ page: 1, limit: 10 });
17  console.log(commentsPage);
18
19  // 특정 게시글의 댓글 목록 가져오기
20  const commentsFilterPostId = await getComments({ postId: 1 });
21  console.log(commentsFilterPostId);
22
23  // 특정 유저의 댓글 목록 가져오기
24  const commentsFilterUserId = await getComments({ userId: 1 });
25  console.log(commentsFilterUserId);
26
27  // 특정 댓글 가져오기
28  const comment = await getComment({ id: 1 });
29  console.log(comment);
30
31  // 댓글 생성
32  const createCommentResult = await createComment({
33    userId: 1,
34    postId: 1,
35    content: "새로운 댓글",
36  });
37  console.log(createCommentResult);
38
39  // 댓글 일부 수정
40  const patchCommentResult = await patchComment(1, { content: "수정된 댓글" });
41  console.log(patchCommentResult);
42
43  // 댓글 전체 수정
44  const putCommentResult = await putComment(1, {
45    content: "수정된 댓글",
46  });
47  console.log(putCommentResult);
48
49  // 댓글 삭제
50  const deleteCommentResult = await deleteComment({ id: 1 });
51  console.log(deleteCommentResult);
52}
53
54fetchComments();

Books

1import {
2  getBooks,
3  getBook,
4  createBook,
5  patchBook,
6  putBook,
7  deleteBook,
8} from "korean-dummy-json-fetcher";
9
10async function fetchBooks() {
11  // 전체 책 목록 가져오기
12  const books = await getBooks();
13  console.log(books);
14
15  // 책 목록 페이지네이션
16  const booksPage = await getBooks({ page: 1, limit: 10 });
17  console.log(booksPage);
18
19  // 특정 책 가져오기
20  const book = await getBook({ id: 1 });
21  console.log(book);
22
23  // 책 추가
24  const createBookResult = await createBook({
25    author: "저자",
26    genre: "소설",
27    title: "새로운 책",
28    publicationDate: "2024-01-01",
29    totalPage: 300,
30  });
31  console.log(createBookResult);
32
33  // 책 일부 수정
34  const patchBookResult = await patchBook(1, { title: "수정된 제목" });
35  console.log(patchBookResult);
36
37  // 책 전체 수정
38  const putBookResult = await putBook(1, {
39    author: "수정된 저자",
40    genre: "수정된 장르",
41    title: "수정된 제목",
42    publicationDate: "2025-01-01",
43    totalPage: 100,
44  });
45  console.log(putBookResult);
46
47  // 책 삭제
48  const deleteBookResult = await deleteBook({ id: 1 });
49  console.log(deleteBookResult);
50}
51
52fetchBooks();

Reviews

1import {
2  getReviews,
3  getReview,
4  createReview,
5  patchReview,
6  putReview,
7  deleteReview,
8} from "korean-dummy-json-fetcher";
9
10async function fetchReviews() {
11  // 전체 책 리뷰 목록 가져오기
12  const reviews = await getReviews();
13  console.log(reviews);
14
15  // 책 리뷰 목록 페이지네이션
16  const reviewsPage = await getReviews({ page: 1, limit: 10 });
17  console.log(reviewsPage);
18
19  // 특정 책 리뷰 목록 가져오기
20  const bookReviews = await getReviews({ bookId: 1 });
21  console.log(bookReviews);
22
23  // 특정 유저 리뷰 목록 가져오기
24  const userReviews = await getReviews({ userId: 1 });
25  console.log(userReviews);
26
27  // 특정 리뷰 가져오기
28  const review = await getReview({ id: 1 });
29  console.log(review);
30
31  // 리뷰 생성
32  const createReviewResult = await createReview({
33    userId: 1,
34    bookId: 1,
35    rating: 5,
36    content: "새로운 리뷰",
37  });
38  console.log(createReviewResult);
39
40  // 리뷰 일부 수정
41  const patchResult = await patchReview(1, { content: "수정된 리뷰" });
42  console.log(patchResult);
43
44  // 리뷰 전체 수정
45  const putResult = await putReview(1, {
46    rating: 3,
47    content: "전체수정 리뷰",
48  });
49  console.log(putResult);
50
51  // 리뷰 삭제
52  const deleteResult = await deleteReview({ id: 1 });
53  console.log(deleteResult);
54}
55
56fetchReviews();

Auth

1import {
2  login,
3  getAuthUser,
4  refreshAccessToken,
5} from "korean-dummy-json-fetcher";
6
7async function fetchAuth() {
8  // 로그인
9  const { accessToken, refreshToken } = await login({
10    id: "test",
11    password: "1234",
12  });
13  console.log(accessToken, refreshToken);
14
15  // 발급받은 accessToken으로 유저 정보 조회
16  const user = await getAuthUser({ accessToken });
17  console.log(user);
18
19  // 발급받은 refreshToken으로 accessToken 재발급
20  const { accessToken: newAccessToken } = await refreshAccessToken({
21    refreshToken,
22  });
23  console.log(newAccessToken);
24}
25
26fetchAuth();

Image

1import { getImage } from "korean-dummy-json-fetcher";
2
3// 동적 이미지 데이터 가져오기
4const image = getImage({
5  size: "300x200",
6  text: "안녕하세요",
7  bgColor: "007bff",
8  textColor: "ffffff",
9  ext: "png",
10});
11console.log(image);

Lorem

1import { getLorem } from "korean-dummy-json-fetcher";
2
3// 한글 로렘 입숨 생성하기
4async function fetchLorem() {
5  const lorem = await getLorem({
6    mode: "p",
7    count: 2,
8    legnth: 200,
9  });
10  console.log(lorem);
11}
12
13fetchLorem();

API Reference

Users

• getUser({ id }: { id: number }) : 특정 유저 정보 반환
• getUsers({ limit?, page? }?: { limit?: number; page?: number }) : 유저 전체 목록 반환
• createUser(data: Omit<User, "id" | "createdAt">) : 유저 생성
• patchUser(id: number, data: Partial<Omit<User, "id" | "createdAt">>) : 유저 일부 수정
• putUser(id: number, data: Omit<User, "id" | "createdAt">) : 유저 전체 수정
• deleteUser({ id }: { id: number }) : 유저 삭제

Todos

• getTodo({ id }: { id: number }) : 특정 할 일 정보 반환
• getTodos({ userId?, limit?, page? }?: { userId?: number; limit?: number; page?: number }) : 할 일 목록 반환
• createTodo(data: Omit<Todo, "id">) : 할 일 생성
• patchTodo(id: number, data: Partial<Omit<Todo, "id">>) : 할 일 일부 수정
• putTodo(id: number, data: Omit<Todo, "id">) : 할 일 전체 수정
• deleteTodo({ id }: { id: number }) : 할 일 삭제

Posts

• getPost({ id }: { id: number }) : 특정 게시글 정보 반환
• getPosts({ userId?, limit?, page? }?: { userId?: number; limit?: number; page?: number }) : 게시글 목록 반환
• createPost(data: Omit<Post, "id" | "createdAt">) : 게시글 생성
• patchPost(id: number, data: Partial<Omit<Post, "id" | "userId" | "createdAt">>) : 게시글 일부 수정
• putPost(id: number, data: Omit<Post, "id" | "userId" | "createdAt">) : 게시글 전체 수정
• deletePost({ id }: { id: number }) : 게시글 삭제

Comments

• getComment({ id }: { id: number }) : 특정 댓글 정보 반환
• getComments({ userId?, postId?, limit?, page? }?: { userId?: number; postId?: number; limit?: number; page?: number }) : 댓글 목록 반환
• createComment(data: Omit<Comment, "id" | "createdAt">) : 댓글 생성
• patchComment(id: number, data: Partial<Omit<Comment, "id" | "userId" | "postId" | "createdAt">>) : 댓글 일부 수정
• putComment(id: number, data: Omit<Comment, "id" | "userId" | "postId" | "createdAt">) : 댓글 전체 수정
• deleteComment({ id }: { id: number }) : 댓글 삭제

Books

• getBook({ id }: { id: number }) : 특정 책 정보 반환
• getBooks({ limit?, page? }?: { limit?: number; page?: number }) : 책 목록 반환
• createBook(data: Omit<Book, "id" | "createdAt">) : 책 생성
• patchBook(id: number, data: Partial<Omit<Book, "id" | "createdAt">>) : 책 일부 수정
• putBook(id: number, data: Omit<Book, "id" | "createdAt">) : 책 전체 수정
• deleteBook({ id }: { id: number }) : 책 삭제

Reviews

• getReview({ id }: { id: number }) : 특정 리뷰 반환
• getReviews({ userId?, bookId?, limit?, page? }?: { userId?: number; bookId?: number; limit?: number; page?: number }) : 리뷰 목록 반환
• createReview(data: Omit<Review, "id" | "createdAt">) : 리뷰 생성
• patchReview(id: number, data: Partial<Omit<Review, "id" | "userId" | "bookId" | "createdAt">>) : 리뷰 일부 수정
• putReview(id: number, data: Omit<Review, "id" | "userId" | "bookId" | "createdAt">) : 리뷰 전체 수정
• deleteReview({ id }: { id: number }) : 리뷰 삭제

Auth

• login({ id, password, ATExp?, RTExp? }: { id: string; password: string; ATExp?: number; RTExp?: number }): 로그인 후 accessToken과 refreshToken을 반환
• getAuthUser({ accessToken }: { accessToken?: string }): accessToken으로 유저 정보를 조회
• refreshAccessToken({ refreshToken }: { refreshToken?: string }): refreshToken으로 accessToken을 재발급

Image

• getImage({ size?, bgColor?, text?, ext?, textColor? }?: { size?: string; bgColor?: string; text?: string; ext?: "jpg" | "jpeg" | "png" | "svg"; textColor?: string }): 동적 이미지 반환

Lorem

• getLorem({ mode?, count?, length? }?: { mode?: "p" | "s" | "w"; count?: number; length?: number }): 한글 로렘 입숨 반환

Type Definitions Example

1export interface User {
2  id: number;
3  username: string;
4  email: string;
5  phone: string;
6  address: string;
7  createdAt: string;
8}
9
10export interface Todo {
11  id: number;
12  userId?: number;
13  content: string;
14  completed: boolean;
15}
16
17export interface Post {
18  id: number;
19  userId: number;
20  title: string;
21  content: string;
22  imgUrl: string;
23  createdAt: string;
24}
25
26export interface Comment {
27  id: number;
28  postId: number;
29  userId: number;
30  content: string;
31  createdAt: string;
32}
33
34export interface Book {
35  id: number;
36  author: string;
37  genre: string;
38  title: string;
39  publicationDate: string;
40  totalPage: number;
41}
42
43export interface Review {
44  id: number;
45  userId: number;
46  bookId: number;
47  rating: number;
48  content: string;
49  createdAt: string;
50}
51export interface AuthUser {
52  userId: string;
53}
54
55export interface Login {
56  accessToken: string;
57  refreshToken: string;
58}
59
60export interface RefreshAccessToken {
61  accessToken: string;
62}
63
64export interface GetLoremResponse {
65  result: string;
66}
67
68export type ApiResponse<T = void, K extends string = never> = {
69  message: string;
70} & {
71  [key in K]: T;
72};
73
74export type PaginatedResponse<T, K extends string> = {
75  message: string;
76  page: number;
77  limit: number;
78  hasNextPage: boolean;
79} & {
80  [key in K]: T[];
81};

License

MIT

Contact

버그를 발견하셨거나, 개선 및 추가 데이터 제안 등 문의사항이 있다면 아래 이메일로 연락 주세요.

📧 Email: dark9737@gmail.com