API 문서

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

프로젝트

프로젝트 관련 API 엔드포인트

GET
/api/v1/projects
모든 프로젝트 목록을 조회합니다.
인증 필요

응답

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

[
  {
    "id": "clq1234abcd",
    "name": "샘플 프로젝트",
    "description": "이것은 샘플 프로젝트입니다.",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z"
  }
]
POST
/api/v1/projects
새로운 프로젝트를 생성합니다.
인증 필요

Request Body (object)

이름타입필수설명
namestring프로젝트 이름
descriptionstring아니오프로젝트 설명

응답

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

{
  "id": "clq1234abcd",
  "name": "새 프로젝트",
  "description": "새 프로젝트 설명",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z"
}
GET
/api/v1/projects/[projectId]
프로젝트 ID로 특정 프로젝트를 조회합니다.
인증 필요

Parameters

이름타입필수설명
projectIdstring조회할 프로젝트의 ID

응답

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

{
  "id": "clq1234abcd",
  "name": "샘플 프로젝트",
  "description": "이것은 샘플 프로젝트입니다.",
  "createdAt": "2023-01-01T00:00:00.000Z",
  "updatedAt": "2023-01-01T00:00:00.000Z",
  "images": [
    {
      "id": "img1234abcd",
      "name": "샘플 이미지",
      "variants": [
        {
          "id": "var1234abcd",
          "url": "https://example.com/image.jpg",
          "type": "original"
        }
      ],
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-01T00:00:00.000Z",
      "projectId": "clq1234abcd"
    }
  ]
}
DELETE
/api/v1/projects/[projectId]
프로젝트 ID로 특정 프로젝트를 삭제합니다.
인증 필요

Parameters

이름타입필수설명
projectIdstring삭제할 프로젝트의 ID

응답

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

{
  "message": "프로젝트가 성공적으로 삭제되었습니다."
}