API 문서

덕질허브 공개 REST API의 사용법을 안내합니다.

Base URL

https://api.deokjilhub.com

인증 방법

인증이 필요한 엔드포인트는 Authorization 헤더에 Bearer 토큰을 포함해야 합니다.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

토큰은 로그인 시 발급되며, access_token의 기본 만료 시간은 30분입니다. 만료 시 /api/v1/auth/refresh로 갱신합니다.

에러 응답 형식

{
  "detail": "error message"
}

HTTP 메서드

GET리소스 조회
POST리소스 생성
PUT리소스 수정
DELETE리소스 삭제

HTTP 상태 코드

코드이름설명
200OK요청 성공
201Created리소스 생성 성공
204No Content삭제 성공 (응답 본문 없음)
400Bad Request잘못된 요청 데이터
401Unauthorized인증 필요
403Forbidden권한 없음
404Not Found리소스를 찾을 수 없음
409Conflict리소스 충돌 (예: 닉네임 중복)
429Too Many Requests요청 횟수 초과 (Retry-After 헤더 포함)

인증

인증된 사용자 정보를 확인하는 엔드포인트입니다. 로그인은 웹 브라우저에서 수행하며, 발급된 토큰으로 API를 호출합니다.

보드

덕질판(보드) 목록 조회, 상세 정보 엔드포인트입니다. 보드 생성은 관리자 전용이며, 사용자는 웹 UI에서 보드 등록을 신청할 수 있습니다.

콘텐츠

콘텐츠 목록 조회, 상세 조회 등의 엔드포인트입니다.

댓글

댓글 조회, 작성, 수정, 삭제, 투표 등의 엔드포인트입니다.

게시물

커뮤니티 게시물 작성, 수정, 삭제 및 보드 팔로우 관련 엔드포인트입니다.

사용자

내 프로필 조회/수정, 통계, 댓글, 팔로잉 보드 등의 엔드포인트입니다. 모든 엔드포인트는 인증이 필요하며 본인 데이터만 조회할 수 있습니다.

리액션

콘텐츠 리액션(좋아요 등) 관련 엔드포인트입니다.

포인트

포인트 조회 엔드포인트입니다. 게시물 작성(5P), 댓글 작성(1P) 등으로 포인트를 획득하며, 퍼스널리티 랜덤 돌리기(10P) 등에 사용됩니다.

퍼스널리티

댓글/게시물에 적용되는 말투 설정입니다. 5가지 성향(츤데레, 엉뚱, 위트, 따뜻, 열정)과 사투리를 조합하며, 랜덤 돌리기로 변경할 수 있습니다.

카테고리

카테고리 목록 조회 엔드포인트입니다.