개요
Article 도메인은 공지사항 및 게시글 관리, 사용자 알림 시스템을 제공합니다. 파일 첨부 기능과 페이지네이션을 지원합니다.Types
Article
게시글 정보를 나타냅니다.게시글 ID
게시글 제목
게시글 내용
첨부 파일 URL 목록
게시글 타입 (예: “notice”, “announcement”)
게시글 태그
생성 일시
UserNotification
사용자 알림 정보를 나타냅니다.알림 ID
알림 키 (고유 식별자)
알림 요약
알림 상세 내용
알림 타입
알림 상태 코드
읽음 여부
공개 알림 여부
대상 사용자 ID
관련 숙박 시설 ID
추가 데이터 (JSON 형식)
생성 일시
만료 일시
관련 URL
Queries
getArticles
게시글 목록을 페이지네이션으로 조회합니다.GraphQL Signature
파라미터
가져올 게시글 개수
페이지네이션 커서 (이 커서 이후의 게시글)
응답
게시글 목록
페이지 정보
전체 게시글 수
예제
getArticle
특정 게시글의 상세 정보를 조회합니다.GraphQL Signature
파라미터
게시글 ID
예제
getMyUserNotifications
현재 로그인한 사용자의 알림 목록을 조회합니다.GraphQL Signature
파라미터
가져올 알림 개수
이 ID 이후의 알림
특정 숙박 시설 관련 알림만 필터링
응답
알림 목록
페이지 정보
전체 알림 수
예제
이 API는 인증이 필요하며, 로그인한 사용자의 알림만 조회됩니다.
Mutations
createArticle
새로운 게시글을 생성합니다.GraphQL Signature
파라미터
게시글 제목
게시글 내용
첨부 파일 URL (JSON 배열 문자열)
게시글 타입
게시글 태그
응답
생성된 게시글 정보
예제
updateArticle
기존 게시글을 수정합니다.GraphQL Signature
파라미터
수정할 게시글 ID
새로운 제목
새로운 내용
새로운 첨부 파일 URL
새로운 타입
새로운 태그
응답
수정된 게시글 정보
deleteArticle
게시글을 삭제합니다.GraphQL Signature
파라미터
삭제할 게시글 ID
응답
삭제 성공 여부
uploadArticleAttachments
게시글에 파일을 첨부합니다.GraphQL Signature
파라미터
파일을 첨부할 게시글 ID
업로드할 파일 목록
유지할 기존 파일 URL 목록
응답
첨부 파일이 업데이트된 게시글 정보
persistFiles를 지정하지 않으면 기존 첨부 파일이 모두 제거됩니다.publishUserNotification
사용자 알림을 발송합니다.GraphQL Signature
파라미터
알림 고유 키
알림 요약
알림 상세 내용
알림 타입 (예: “reservation”, “payment”, “system”)
알림 상태 코드
읽음 여부 (기본값: false)
공개 알림 여부
특정 사용자에게만 발송 (미지정 시 전체 공지)
관련 숙박 시설 ID
특정 권한을 가진 직원에게만 발송
알림 만료 일시
추가 데이터 (JSON 문자열)
관련 URL
응답
발송된 알림 목록 (여러 사용자에게 발송된 경우 배열로 반환)
예제
deleteUserNotification
사용자 알림을 삭제합니다.GraphQL Signature
파라미터
삭제할 알림 ID
응답
삭제 성공 여부
markReadUserNotifications
여러 알림을 읽음 처리합니다.GraphQL Signature
파라미터
읽음 처리할 알림 ID 목록
응답
읽음 처리된 알림 개수
예제
사용 흐름
게시글 관리 흐름
- 게시글 작성:
createArticle로 게시글 생성 - 파일 첨부 (선택):
uploadArticleAttachments로 파일 업로드 - 게시글 수정 (선택):
updateArticle로 내용 수정 - 게시글 삭제:
deleteArticle로 삭제
알림 시스템 흐름
- 알림 발송:
publishUserNotification으로 알림 생성 및 발송 - 알림 조회: 사용자가
getMyUserNotifications로 알림 확인 - 읽음 처리:
markReadUserNotifications로 알림 읽음 처리 - 알림 삭제:
deleteUserNotification으로 알림 삭제
알림 타겟팅
특정 사용자에게 발송관련 API
- 사용자 API - 사용자 정보 관리
- Core Service - 예약 관련 알림