[BackEnd] 게시판/온보딩 비즈니스 로직 설계

[sooah-0208]

확정안

API 명세서

게시판 및 온보딩 관련 API 명세서

1. 게시판 지표 및 목록 조회 (GET)

Description: 상단 KPI 요약 카드, 지표 테이블 목록, 검색 필터링 및 페이지네이션 데이터를 조회합니다.

항목	내용
Method	GET
URL	/board
Auth	-

Request Parameters

1. Query Parameters

Model명	형식	필수여부	설명
companyId	str	Required	localStorage에서 가져온 관리자 소속 회사 식별 ID
status	str	Optional	상태 필터링 조건 (pending, approved, rejected)
limit	int	Required	현재 페이지 번호 (프론트엔드 dataPage 변수와 연동)
userSearch	str	Optional	사용자명/이메일/이슈그룹 통합 검색어

Response Body (JSON)

성공

{
  "status": true,
  "message": "데이터 목록 조회가 완료되었습니다.",
  "data": {
    "summary": { "pending": 10, "approved": 7, "rejected": 5 },
    "totalCount": 22,
    "totalPages": 3,
    "items": [
      {
        "id": 101,
        "issueGroup": "Climate",
        "questionName": "온실가스 배출량",
        "value": "450 tCO2eq",
        "userName": "이채훈",
        "status": "pending",
        "attachmentFile": "skm_env_01.pdf",
        "rejectReason": null
      }
    ]
  }
}

실패

{ 
"status": false 
}

---

2. 온보딩 마지막 작업 조회 (POST)

Description: 온보딩 가장 마지막 작업 내용을 불러옵니다.

항목	내용
Method	POST
URL	/board
Auth	-

Request Parameters

1. Body Parameters

Model명	형식	필수여부	설명
offset	-	-	-
category	-	-	-
subCategory	-	-	-

Response Body (JSON)

성공

{
  "status": true,
  "message": "",
  "data": {}
}

실패

{ 
  "status": false 
}

---

3. 작업 내용 저장 (PUT)

Description: 추가된 작업 내용을 저장합니다. 변경이력이 누락되지 않도록 insert만 진행합니다.

항목	내용
Method	PUT
URL	/board
Auth	-

Request Parameters

1. Body Parameters
(제공된 필드 정보가 없어 기본 구조로 표시됩니다)

Response Body (JSON)

성공

{
  "status": true,
  "message": "",
  "data": {}
}

실패

{
 "status": false 
}

---

참고사항

각 서비스 구축 이후 변경 예정

영향 범위

FE @x2bjvhmmwg-gif / BE / 문서 @frankie516c

담당자

@mpsddd-commits , @choiyc05, @sooah-0208

결정일

2026-05-04