앞장에 API가 뭔지 컴공 취준생이 알만한 용어들로 정리했지만, 아직 사용해보지 않았으니 체감되지 않을 것이다.

JSON

주로 API는 json이라는 형태로 제공되는데, 파이썬의 딕셔너리 형태라고 이해하면 편하다

예를 들어, 무언가 요청했을 때 나오는 반환값을 json으로 달라하면, 아래처럼 나올 수 있다

{
'job':'student',
'age':24',
'hobby':{
		'sport':'soccer',
		'music':'piano',
		'other':['movie', 'sleeping']
	}
}

이러면 이렇게 나온 형태를 json으로 인지/변환하고 (대부분 코딩 언어에서는 json 형태로 변환이 지원된다)

파이썬의 경우 딕셔너리처럼 사용하면 된다

다만, 일반 파이썬 딕셔너리와 달리 딕셔너리 안의 딕셔너리 형태로 값이 반환될 수 있다.

이를 nested json이라고도 부른다

딕셔너리도 같은 형태를 사용 가능은 하지만 잘 사용하지는 않는다

이를 사용하는 방법은 아래 예시에서 더 살펴본다

명세 확인하기

앞장에서 소개한대로, 정보를 요청할 주소는 {ecs_ip}:8000 이다.

pycaret의 경우, {ecs_ip}:8000/docs 를 입력하면 요청 과 반환 정보의 명세를 잘 정리해서 보여준다

보통 이 명세를 schema라고 한다

다른 방식으로 API를 개발해서 전달하는 경우 직접 schema를 사용하거나 다른 툴을 사용한다

참고) https://swagger.io

보면 아래와 같다

doc 대신 predict라는 함수를 사용할 수 있다는 것을 의미하고

인풋으로 candle_date_time_kst, open, high, low, close, volume을 넣을 수 있음을 의미한다

필수요소도 확인할 수 있고, 인풋 값의 형태가 어떤지도 예시와 함께 볼 수 있다