Skip to content

API 설계

Znero edited this page Nov 28, 2024 · 6 revisions

API 명세서

API 명세서

API 설계

SHELL

Name HTTP URI
쉘 전체 조회 GET /api/shells
쉘 조회 GET /api/shells/:shell-id
쉘 삭제 DELETE /api/shells/:shell-id
쉘 쿼리 수정 PUT /api/shells/:shell-id
쉘 추가 POST /api/shells

QUERY

Name HTTP URI
쿼리 실행 POST /api/shells/:shell-id/execute

TABLE

Name HTTP URI
테이블 전체 조회 GET /api/tables
테이블 조회 GET /api/tables/:tableName

RECORD

Name HTTP URI
랜덤 레코드 삽입 POST /api/record

USAGE

Name HTTP URI
사용량 조회 GET /api/usage

response format

  • 정상
{
  "status": true,
  "data": {
    "id": 123,
    "name": "John Doe",
    "email": "[email protected]"
  },
  "message": "Request processed successfully"
}
  • 에러
{
  "status": false,
  "error": {
    "code": 404,
    "message": "Resource not found"
  }
}
Clone this wiki locally