15분
OpenAI API 문서를 읽어야 할 때
Day 2: API 문서 읽기
OpenAI API 문서를 읽어야 할 때
영어 문서 독해: API 문서, GitHub, Stack Overflow > Day 2: API 문서 읽기
학습 목표
API 문서를 읽어야 하는 상황을 이해한다 API 문서의 기본 구조를 파악한다
"API 문서 읽어보고 구현해"
팀장: "GPT API 연동해야 해. OpenAI 문서 보고 해봐."
OpenAI 공식 문서를 열었다.
에디터 로딩 중...
뭔 소리지?
영어도 문제지만, 구조 자체를 모르겠다. POST? Request body? Optional?
블로그 찾아봤다. "OpenAI API 사용법". 그런데 버전이 다르다. 코드가 안 돌아간다.
결국 공식 문서를 읽어야 했다.
왜 공식 문서를 읽어야 하나?
| 블로그 | 공식 문서 |
|---|---|
| 오래된 버전일 수 있음 | 항상 최신 |
| 작성자가 틀릴 수 있음 | 정확함 |
| 일부 기능만 설명 | 전체 기능 설명 |
| 복붙해도 안 될 수 있음 | 복붙하면 됨 |
공식 문서가 정답지다. 읽을 줄 알면 문제를 직접 해결할 수 있다.
API 문서의 기본 구조
모든 API 문서는 이 구조를 따른다:
에디터 로딩 중...
오늘은 이 구조를 완전히 이해할 것이다.