Board API
공지사항 API
공지사항 서비스는 게임 내에서 사용자에게 중요한 정보나 업데이트를 알리는 데 사용됩니다. 게임의 업데이트, 이벤트 정보, 서비스 변경 사항 등이 포함됩니다.
공지사항 목록조회
이 API는 사용자에게 공지사항 목록을 페이징 처리하여 상세 조회할 수 있게 해줍니다.
Operation
query NoticeConnection($first: Int, $offset: Int) {
noticeConnection(first: $first, offset: $offset) {
nodes {
id
title
description
isNew
createdAt
}
totalCount
}
}Variables
{
"first": 10,
"offset": 0
}공지사항 상세조회
이 API는 특정 공지사항의 상세 정보를 조회할 수 있게 해줍니다. 이 쿼리는 공지사항의 상세 정보를 조회할 때 사용됩니다. 필요한 정보는 공지사항의 id를 통해 얻을 수 있으며, 반환되는 정보에는 공지사항의 id, title, description, isNew, createdAt가 포함됩니다. isNew는 사용자가 해당 공지사항을 읽었는지 여부를 나타내며, 읽지 않았다면 true, 읽었다면 false입니다.
Operation
query Notice($input: NoticeInput!) {
notice(input: $input) {
id
title
description
isNew
createdAt
}
}Variables
{
"input": {
"id": null
}
}관리자 - 공지사항 API
Admin 권한이 있는 사용자만 접근이 가능합니다.
[관리자] 공지사항 등록
관리자가 새로운 공지사항을 등록하는 기능입니다.
Operations
mutation AdminCreateNotice($input: AdminCreateNoticeInput!) {
adminCreateNotice(input: $input) {
success
}
}Variables
{
"input": {
"title": "공지사항 제목",
"description": "공지사항 내용",
"isTop": false,
"status": true
}
}[관리자] 공지사항 수정
관리자가 기존 공지사항을 수정하는 기능입니다.
Operations
mutation AdminUpdateNotice($input: AdminUpdateNoticeInput!) {
adminUpdateNotice(input: $input) {
success
}
}Variables
{
"input": {
"id": "공지사항 고유 아이디",
"title": "수정된 공지사항 제목",
"description": "수정된 공지사항 내용",
"isTop": true,
"status": false
}
}[관리자] 공지사항 삭제
관리자가 공지사항을 삭제하는 기능입니다.
Operations
mutation AdminDeleteNotice($input: AdminDeleteNoticeInput!) {
adminDeleteNotice(input: $input) {
success
}
}Variables
{
"input": {
"id": "공지사항 고유 아이디"
}
}[관리자] 공지사항 목록조회
이 API는 관리자가 공지사항 목록을 상세 조회할 수 있게 해줍니다. 공지사항은 first, offset, orderBy, filter 조건을 사용하여 페이징과 정렬, 필터링이 가능합니다. 이 쿼리는 공지사항을 조회할 때 사용되며, first와 offset을 통해 페이징 처리를 할 수 있습니다. orderBy와 filter를 통해 결과를 정렬하고, 특정 조건에 맞는 공지사항만 필터링할 수 있습니다. 반환되는 nodes 배열은 조회된 공지사항의 목록이며, totalCount는 전체 공지사항 수를 나타냅니다. status 필드는 공지사항의 노출 여부를 나타내며, true일 경우 공개된 공지사항입니다.
Operation
query AdminNoticeConnection($first: Int, $offset: Int, $orderBy: AdminNoticeConnectionOrderBy, $filter: AdminNoticeConnectionFilter) {
adminNoticeConnection(first: $first, offset: $offset, orderBy: $orderBy, filter: $filter) {
nodes {
id
title
description
isTop
status
adminUserNo
createdAt
}
totalCount
}
}Variables
{
"first": 10,
"offset": 0,
"orderBy": {
"field": "CREATED_AT",
"direction": "DESC"
},
"filter": {
"keyword": "특정 키워드",
"title": "공지사항 제목",
"adminUserNo": "관리자 번호",
"status": true
}
}[관리자] 공지사항 상세조회
이 API는 관리자가 특정 공지사항의 상세 정보를 조회할 수 있게 해줍니다. 공지사항의 고유 아이디를 사용하여 해당 공지사항의 상세 내용을 얻을 수 있습니다.
Operation
query AdminNotice($input: AdminNoticeInput!) {
adminNotice(input: $input) {
id
title
description
isTop
status
adminUserNo
createdAt
}
}Variables
{
"input": {
"id": "공지사항 고유 아이디"
}
}[관리자] 공지사항 히스토리 목록조회
이 API는 관리자가 특정 공지사항의 수정 이력 목록을 상세 조회할 수 있게 해줍니다. 수정 이력은 first, offset을 사용하여 페이징 처리할 수 있습니다.
Operation
query AdminNoticeHistoryConnection($noticeId: String, $first: Int, $offset: Int) {
adminNoticeHistoryConnection(noticeId: $noticeId, first: $first, offset: $offset) {
nodes {
id
noticeId
title
description
isTop
status
adminUserNo
createdAt
}
totalCount
}
}Variables
{
"noticeId": "공지사항 고유 아이디",
"first": 10,
"offset": 0
}[관리자] 공지사항 히스토리 상세조회
이 API는 관리자가 특정 공지사항 히스토리의 상세 정보를 조회할 수 있게 해줍니다.
Operation
query AdminNoticeHistory($input: AdminNoticeHistoryInput!) {
adminNoticeHistory(input: $input) {
id
noticeId
title
description
isTop
status
adminUserNo
createdAt
}
}Variables
{
"input": {
"id": "공지사항 히스토리 고유 아이디"
}
}