Skip to content

REST API 설계

Hee edited this page May 28, 2025 · 3 revisions

REST API 설계

HTTP 메서드 URI 설명 요청 바디 / 응답 예시
POST /documents 새 문서 생성 { title, description, author }
GET /documents/{documentId} 문서 상세 조회 문서 상세 정보 + 첨부파일 목록
PUT /documents/{documentId} 문서 수정 { title, description, status }
DELETE /documents/{documentId} 문서 삭제 (상태 변경) 상태를 DELETED로 변경

| POST | /documents/{documentId}/files | 문서에 파일 첨부 | Multipart/form-data (file) | | GET | /documents/{documentId}/files/{fileId} | 특정 파일 상세 조회 | 파일 메타정보 + 현재 버전 정보 | | DELETE | /documents/{documentId}/files/{fileId} | 파일 삭제 (상태 변경) | 상태를 비활성화 등 |

| POST | /files/{fileId}/versions | 파일 버전 업로드 | Multipart/form-data (file), changeReason(optional) | | GET | /files/{fileId}/versions/{versionNo} | 특정 버전 다운로드 | 파일 바이너리 또는 메타정보 | | PUT | /files/{fileId}/versions/{versionNo}/restore | 특정 버전 복원 | 이전 버전을 현재 버전으로 설정 |

ADR 문서

도메인 정의서

REST API 설계

시퀀스 다이어그램

Clone this wiki locally