/cat_picture_search

OpenFeign을 이용한 API 연동 실습

Primary LanguageJava

cat_picture_search

주제(시나리오)

고양이를 좋아하는 당신은 고양이 사진 전용 검색 웹사이트를 구현해보려고 합니다. 고양이 사진이 나와야 하기 때문에 데이터를 가져와야 하는데 좋은 오픈 API가 존재합니다. 그 API를 이용해 데이터를 DB에 저장하고 서비스를 만들어 봅시다.

과제 설명

  • TheCatApi에서 일부분의 데이터를 가져옵니다.
  • OpenFeign을 이용하여 웹 서비스 클라이언트를 보다 쉽게 작성할 수 있습니다.
  • DB를 세팅하기 위해 Docker를 이용해서 DB세팅을 해봅니다.

API 설명

1. GET /cats/random50

Request parameter

None

Query paramter

None

Response

Success 200

Field name Type Description
data Array 랜덤한 50개의 고양이 사진 목록입니다. 
HTTP/1.1 200 OK
{
  "data": [{
    id: string
    url: string
    name: string
  }]
}

2. GET /cats/search

Request parameter

None

Query paramter

Field name Type Description
q string 고양이의 품종(영어/한글)

Response

Success 200

Field name Type Description
data Array Keyword로 검색된 고양이 사진 목록입니다. 
HTTP/1.1 200 OK
{
  "data": [{
    id: string
    url: string
    name: string
  }]
}

3. GET /cats/:id

Request parameter

Field name Type Description
id string 고양이 사진의 id값 입니다.

Query paramter

None

Response

Success 200

Field name Type Description
data Object Id로 검색된 고양이 사진 입니다. 
HTTP/1.1 200 OK
{
  "data": {
    name: string
    id: string
    url: string
    width: number
    height: number
    temperament: string
    origin: string
  }
}

실행 방법

src/resources/application-api-key.yaml 파일 생성

THE_CAT_CLIENT_URL : https://api.thecatapi.com/v1
THE_CAT_CLIENT_KEY : {the cat api private key}