aladin-client

알라딘 온라인 서점 API를 JavaScript로 쉽게 사용할 수 있게 해주는 비공식 라이브러리입니다.

설치 방법

npm

npm install aladin-client

yarn

yarn add aladin-client

pnpm

pnpm add aladin-client

기능

제공하는 메서드들은 OPEN API의 각 요청과 1:1 대응됩니다.

• 상품 검색 (ItemSearch.aspx)
• 상품 리스트 조회 (ItemList.aspx)
• 상품 조회 (ItemLookUp.aspx)
• 중고상품 보유 매장 검색 (ItemOffStoreList.aspx)

빠른 시작

import { Aladin } from 'aladin-client'

// 클라이언트 초기화
const aladin = new Aladin({ttbKey: '<YOUR TTB KEY>'})

// 상품 검색
const searchResult = await aladin.searchItems({query: 'Harry Potter'})
if (searchResult.success) {
  console.log(searchResult.data)
} else {
  console.error(searchResult.error.message)
}

// 상품 리스트 조회
const listResult = await aladin.listItems({queryType: 'ItemNewAll', categoryId: 57923 })
if (listResult.success) {
  console.log(listResult.data)
} else {
  console.error(listResult.error.message)
}

// 상품 조회
const itemResult = await aladin.lookupItem({itemId: 343667067, itemIdType: 'ItemId'})
if (itemResult.success) {
  console.log(itemResult.data)
} else {
  console.error(itemResult.error.message)
}

// 중고상품 보유 매장 검색
const offStoreResult = await aladin.listItemOffStore({itemId:343667067 , itemIdType: "ItemId"})
if (offStoreResult.success) {
  console.log(offStoreResult.data)
} else {
  console.error(offStoreResult.error.message)
}

API 문서

• 공식 설명은 API 페이지 및 문서에서 확인 가능합니다.
• 해당 라이브러리의 상세 API는 API 페이지에서 확인 가능합니다.

개발 환경 설정

저장소 클론

# 저장소 클론
git clone https://github.com/username/aladin-client.git
cd aladin-client

의존성 설치

pnpm install

테스트 실행

테스트 실행을 위해 tests/ 디렉토리에 key.json 파일을 key.template.json 형식에 맞게 생성하세요. 그 후,

pnpm test

빌드

pnpm build

코드 포맷

pnpm format

기여 방법

🎉 누구나 기여를 환영합니다! 버그 수정, 기능 추가, 문서 개선 등 어떤 형태든 기여는 프로젝트의 발전에 큰 도움이 됩니다.

1. 이 저장소를 포크합니다.
2. 새 기능 브랜치를 생성합니다 (git checkout -b feature/amazing-feature)
3. 변경 사항을 커밋합니다 (git commit -m 'Add some amazing feature')
4. 브랜치에 푸시합니다 (git push origin feature/amazing-feature)
5. Pull Request를 생성합니다.

라이선스

이 프로젝트는 MIT 라이선스로 배포됩니다. 자세한 내용은 LICENSE 파일을 참고하세요.

주의사항

1. KEY 필요
   • 이 라이브러리를 사용하기 위해서는 알라딘 API 키가 필요합니다. API 키 발급 및 이용 약관은 알라딘 API 페이지를 참조하세요.
   • API 사용 시 알라딘의 이용 약관을 준수해야 합니다.
2. 비공식 라이브러리
   • 이 라이브러리는 알라딘 공식 라이브러리가 아닙니다. 따라서 알라딘 API의 변경에 따라 작동하지 않을 수 있습니다.
3. 타입스크립트 지원
   • 이 라이브러리는 타입스크립트를 지원합니다.
   • 공식 API 문서가 정확하지 않은 점, 그리고 별도 협의로 제공되는 결과값은 테스트할 수 없어 타입이 완벽하지 않을 수 있습니다.