부록 A. 전체 API 엔드포인트 목록#
인증(Authentication) API (LOCAL 모드 전용)#
| HTTP | 엔드포인트 | 필요 권한 | 설명 |
|---|---|---|---|
| POST | /api/auth/token | 없음 (API Key 인증) | JWT 토큰 발급 |
| POST | /api/auth/refresh | 없음 (Refresh Token) | Access Token 갱신 |
| POST | /api/auth/logout | 인증 필요 | 로그아웃 |
초기 설정(Setup) API (LOCAL 모드 전용)#
| HTTP | 엔드포인트 | 필요 권한 | 설명 |
|---|---|---|---|
| GET | api/setup/status | 없음 | 초기 설정 필요 여부 조회 |
| POST | api/setup/initalize | Setup Token | 초기 Admin API Key 생성 |
컬렉션(Collection) API#
아래 표에서 일반 컬렉션은
일반, 공유 컬렉션(shared=ture 컬렉션)은공유로 표기
| HTTP | 엔드포인트 | 필요 권한 | 설명 |
|---|---|---|---|
| POST | /api/collections | - 일반: CREATE/ADMIN - 공유: SHARED/ADMIN |
컬렉션 생성 |
| GET | /api/collections | READ/ADMIN | 컬렉션 목록 조회 |
| GET | /api/collections/{name} | - 일반: CREATE/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
컬렉션 메타데이터 조회 |
| DELETE | /api/collections/{name} | - 일반: DROP/ADMIN - 공유: SHARED/ADMIN |
컬렉션 삭제 |
문서(Document) API#
| HTTP | 엔드포인트 | 권한 | 설명 |
|---|---|---|---|
| POST | /api/collections/{name}/documents | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
단일 문서 삽입 |
| POST | /api/collections/{name}/documents/batch | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
다중 문서 삽입 |
| GET | /api/collections/{name}/documents | - 일반: READ/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
전체 문서 조회 |
| GET | /api/collections/{name}/documents/{key} | - 일반: READ/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
키로 문서 조회 |
| POST | /api/collections/{name}/documents/search | - 일반: READ/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
조건부 문서 조회 |
| POST | /api/collections/{name}/documents/jsonpath | - 일반: READ/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
JsonPath로 문서 조회 |
| PUT | /api/collections/{name}/documents/{key} | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
키로 문서 교체 |
| PUT | /api/collections/{name}/documents/replace-one | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
조건부 문서 교체 |
| DELETE | /api/collections/{name}/documents/{key} | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
키로 문서 삭제 |
| POST | /api/collections/{name}/documents/delete-one | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
조건부 단일 문서 삭제 |
| POST | /api/collections/{name}/documents/delete-many | - 일반: WRITE/ADMIN - 공유: SHARED/ADMIN |
조건부 다중 문서 삭제 |
| GET | /api/collections/{name}/documents/count | - 일반: READ/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
전체 문서 개수 |
| POST | /api/collections/{name}/documents/count | - 일반: READ/WRITE/ADMIN - 공유: READ/WRITE/SHARED/ADMIN |
조건부 문서 개수 |
컬렉션 공유(Shared Access) API#
| HTTP | 엔드포인트 | 필요 권한 | 설명 |
|---|---|---|---|
| POST | /api/collections/{collectionName}/grant | CREATE/ ADMIN | 컬렉션 권한 부여 |
| DELETE | /api/collections/{collectionName}/grant/{userId} | DROP/ADMIN | 컬렉션 권한 회수 |
| GET | /api/collections/grants | READ/ADMIN | 내가 부여한 권한 목록 |
| GET | /api/collections/shared-with-me | READ/ADMIN/SHARED | 공유받은 컬렉션 목록 |
관리자(Admin) API (LOCAL 모드 전용)#
| HTTP | 엔드포인트 | 필요 권한 | 설명 |
|---|---|---|---|
| POST | /api/admin/api-keys | ADMIN | API Key 생성 |
| GET | /api/admin/api-keys | ADMIN | API Key 목록 조회 |
| DELETE | /api/admin/api-keys/{clientId} | ADMIN | API Key 삭제 |
| PUT | /api/admin/api-keys/{clientId}/revoke | ADMIN | API Key 폐기 |
| PUT | /api/admin/api-keys/{clientId}/permissions | ADMIN | API Key 권한 수정 |
| POST | /api/admin/api-keys/{clientId}/db-account | ADMIN | 테넌트 DB 계정 생성 |