Files
Gnuboard7/modules/_bundled/sirsoft-board/docs/api/board-activities.md
T
HeuJung b10e89bef0 fix(core,board,ecommerce,page,gdpr,ckeditor5,kginicis,admin_basic,basic): 목록 조회·검증 계층 정비 및 감사 지적 전건 처리
목록 조회 성능 축(깊은 OFFSET·정렬·색인)과 그 검증 계층에서 계획서 전수검수와 3회에 걸친
감사가 지적한 항목을 처리했다. 세부 경위는 의 각 회차 문서에 있다.

검증 계층 — 컨트롤러가 base Request 를 직접 주입받던 확장 13곳을 전용 FormRequest 로 옮겼다.
옮기면서 기존 동작 계약은 그대로 두었다: 상한 초과 limit 을 거부하지 않고 상한까지 반환하던
공개 API, per_page 를 범위로 조정하던 관리자 목록, 미지원 period 를 year 로 해석하던 인기글
목록 모두 종전과 같은 응답을 낸다. 상한/폴백을 rules 로 승격시키면 200 이던 응답이 422 가
되어 기존 링크가 깨지므로, 규칙은 타입만 닫고 클램프·폴백은 접근자가 맡는다. period 는
접근자가 닫힌 집합만 반환해 캐시 키 공간도 함께 닫힌다.

ckeditor5 이미지 업로드만 ResponseHelper 봉투를 쓰지 않는다. 응답을 파싱하는 주체가 CDN 으로
로드되는 상위 CKEditor5 43.3.1 의 SimpleUploadAdapter 라 규약을 바꿀 수 없어, 각 응답 지점에
사유를 명시한 면제를 부착하고 근거를 API 문서에 남겼다.

하네스 — 룰 5개의 대상 경로 패턴이 매처와 맞지 않아 번들 확장 컨트롤러가 검사 대상에서
통째로 빠져 있었다. 패턴을 고치자 확장 위반 17건이 드러나 전건 처리했다. severity 오타가
요약 집계 양쪽에 안 잡혀 "0 error" 로 보고되던 문제도 런너 사전 검증으로 막았다.

정렬 게이트 대조 하네스는 관계 정렬 변형만 쓰는 저장소를 탐지하지 못한 채 통과시키고 있었다.
탐지·제외·인자 파싱을 함께 고치고 단위 테스트를 신설했다.
2026-08-02 15:29:29 +09:00

5.8 KiB

Board Activities API 레퍼런스

소유: module sirsoft-board · 생성: php artisan api:docgen (실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.


TL;DR (5초 요약)

1. 이 문서는 실제 API 호출로 실측한 Board Activities 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 실측 응답 필드 표
3. 응답 필드의 예시값은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다

GET /api/modules/sirsoft-board/me/board-activities

  • 라우트명: api.modules.sirsoft-board.me.board-activities.index
  • 컨트롤러: Modules\Sirsoft\Board\Http\Controllers\User\UserActivityController@index
  • 인증/권한: auth:sanctum

요청 파라미터

요청 파라미터 없음.

요청 예시

GET /api/modules/sirsoft-board/me/board-activities HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}

응답 필드 (data 내부)

목록 응답: data.data[] 배열 항목의 필드.

필드 타입 실측 예시값 용도/설명
id integer 237 기본 키 (내부 식별자)
board_slug string apidoc-sample-board 게시글이 속한 게시판의 슬러그(URL 식별자)입니다. 게시판 상세 링크 구성에 사용합니다.
board_name string API 문서 샘플 게시판 게시글이 속한 게시판의 표시 이름입니다. 현재 로케일에 맞는 다국어 이름(getLocalizedName())이 적용됩니다.
activity_type string authored 활동 유형입니다. authored(본인이 작성한 글) 또는 commented(본인이 댓글을 단 글)로, 요청의 activity_type 필터(기본 authored)에 대응합니다.
activity_count integer 0 activity 개수 (집계)
title string API 문서 샘플 게시글 제목
is_secret boolean false secret 여부
status string published 게시글 상태입니다. published(공개), blinded(블라인드 처리), deleted(삭제) 등 PostStatus 값이며, UI에서 블라인드/삭제 배지 표시에 사용합니다.
view_count integer 43 view 개수 (집계)
comment_count integer 0 comment 개수 (집계)
created_at string 2026-07-07 09:34:50 생성 일시
created_at_formatted string 4시간 전 created_at 값의 표시용 포맷 문자열 (통화/용량/일시 등 로케일·단위 포맷)
content_plain string API 레퍼런스 실측용 완전 샘플 게시글 본문입니다. 게시글 본문의 순수 텍스트입니다. HTML 모드 글은 태그를 제거한 평문으로 변환되며, 목록 미리보기용으로 사용합니다.

응답 예시

HTTP/1.1 200
{
    "success": true,
    "message": "내 활동 게시글을 조회했습니다.",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "board_slug": "apidoc-sample-board",
                "board_name": "API 문서 샘플 게시판",
                "activity_type": "authored",
                "activity_count": 0,
                "title": "API 문서 샘플 게시글",
                "is_secret": "{MASKED}",
                "status": "published",
                "view_count": 44,
                "comment_count": 0,
                "created_at": "2026-07-08 10:41:34",
                "created_at_formatted": "4시간 전",
                "content_plain": "API 레퍼런스 실측용 완전 샘플 게시글 본문입니다."
            }
        ],
        "first_page_url": "https://api.example.com/api/modules/sirsoft-board/me/board-activities?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://api.example.com/api/modules/sirsoft-board/me/board-activities?page=1",
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "page": null,
                "active": false
            },
            {
                "url": "https://api.example.com/api/modules/sirsoft-board/me/board-activities?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "page": null,
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://api.example.com/api/modules/sirsoft-board/me/board-activities",
        "per_page": 25,
        "prev_page_url": null,
        "to": 1,
        "total": 1,
        "query": {
            "board_slug": "",
            "search": "",
            "sort": "latest",
            "activity_type": ""
        }
    }
}

에러 응답

상태코드 의미 발생 조건
401 Unauthenticated 유효한 Bearer 토큰이 없거나 만료된 경우

설명 로그인한 회원 본인의 게시글 활동을 마이페이지에 표시하기 위해 반환합니다. auth:sanctum 인증이 필요한 회원 전용 엔드포인트로, 대상 사용자는 항상 인증된 본인(Auth::id())입니다. board_slug·search·activity_type·sort(latest/oldest/views) 필터와 per_page(기본 20, 허용 범위 1~100) 페이지네이션을 지원하며, 응답에는 적용된 필터가 query 로 함께 담깁니다. 범위를 벗어난 per_page 는 오류 대신 경계값으로 잘립니다(0·음수 → 1, 100 초과 → 100).