API 레퍼런스에 요청 예시(raw HTTP)·응답 예시(envelope 전문)를 표준 포맷에 편입하고, 전 대상(코어+전 모듈+전 플러그인)에 방출했다. 예시 결함 8종 (multipart·Host 마스킹·write 실측·path 치환·현실적 바디·query 반영·중복 제거·민감값 마스킹)을 스캐폴더/프로브 공용 수정으로 근본 해소했다. 추가로 검증에서 드러난 결함을 마감했다: - 응답 예시 body 의 절대 URL(페이지네이터·콜백) 호스트를 placeholder 로 마스킹(maskResponseHost) — 요청 Host 헤더만 마스킹되던 누락 보완, 확장 39건 정정 - api:docgen 커맨드 통합 테스트 신설(라우트 수집·확장 라우팅·rules 추출· 멱등 재생성·check drift) - module-routing.md URL 스킴 오류 정정(/api/admin → /api/modules) - README·cheatsheet·api-documentation 에 API 문서 커맨드/레퍼런스 진입점 반영 전 대상 3칸 완료로 api-doc-coverage 룰을 warn→error 승격.
5.6 KiB
5.6 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) 페이지네이션을 지원하며, 응답에는 적용된 필터가 query 로 함께 담깁니다.