API 문서

Leemage API의 사용법과 엔드포인트 정보를 확인하세요. API를 사용하려면 인증이 필요할 수 있습니다.

📦 TypeScript SDK
npm

npm 패키지를 사용하면 복잡한 API 호출을 간단하게 처리할 수 있습니다.

terminal
1npm install leemage-sdk
Projects

프로젝트 관리 API

GET
/api/v1/projects
프로젝트 목록 조회
인증 필요

응답

프로젝트 목록이 성공적으로 반환됩니다.

[
  {
    "id": "clq1234abcd",
    "name": "내 웹사이트 에셋",
    "description": "웹사이트에서 사용할 이미지 모음",
    "storageProvider": "OCI",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
]
POST
/api/v1/projects
프로젝트 생성
인증 필요

Request Body (object)

이름타입필수설명
namestring이름
descriptionstring아니오설명
storageProvider"OCI" | "R2"아니오스토리지 프로바이더

응답

프로젝트가 성공적으로 생성되었습니다.

{
  "id": "clq1234abcd",
  "name": "내 웹사이트 에셋",
  "description": "웹사이트에서 사용할 이미지 모음",
  "storageProvider": "OCI",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z"
}
GET
/api/v1/projects/{projectId}
프로젝트 상세 조회
인증 필요

Parameters

이름타입필수설명
projectIdstring

응답

프로젝트가 성공적으로 반환됩니다.

{
  "id": "clq1234abcd",
  "name": "내 웹사이트 에셋",
  "description": "웹사이트에서 사용할 이미지 모음",
  "storageProvider": "OCI",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "files": [
    {
      "id": "file5678efgh",
      "name": "image.jpg",
      "mimeType": "image/jpeg",
      "isImage": true,
      "size": 102400,
      "url": null,
      "variants": [
        {
          "url": "https://objectstorage.ap-seoul-1.oraclecloud.com/...",
          "width": 1920,
          "height": 1080,
          "size": 102400,
          "format": "webp",
          "label": "original"
        }
      ],
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "projectId": "clq1234abcd"
    }
  ]
}
DELETE
/api/v1/projects/{projectId}
프로젝트 삭제
인증 필요

Parameters

이름타입필수설명
projectIdstring

응답

프로젝트가 성공적으로 삭제되었습니다.

{
  "message": "작업이 완료되었습니다."
}