간단히 말하면: API는 소프트웨어 시스템이 요청과 데이터를 주고받는 합의된 인터페이스입니다. API 문서에는 작업, 입력, 출력, 인증 및 제한 사항이 정의되어 있습니다.
실무에서 API를 사용하는 방법
저는 API 프로토타입과 운영 프로세스를 구분합니다. 프로토타입은 유용성을 검증하고, 운영 환경에는 권한, 제한, 모니터링 및 대체 경로가 필요합니다. 결과가 설득력 있게 들린다는 이유만으로 사실로 받아들이지 않으며, 중요한 주장은 원출처까지 추적합니다.
주의할 점
가장 큰 위험은 불명확한 프로세스를 자동화하는 것입니다. 그러면 API가 일관되지 않은 결과를 더 빠르게 만들어 내고 오류의 원인을 추적하기 어렵게 합니다. 민감한 데이터, 알 수 없는 서비스 상태, 쉽게 되돌릴 수 없는 의사결정을 주의해야 합니다.
의사결정을 위한 질문
- 기술이 개선해야 할 구체적인 작업은 무엇입니까?
- 어떤 데이터를 사용해도 되며, 결과를 누가 확인합니까?
- 실제 사례에서 정확도와 비용을 어떻게 측정할 것입니까?
- 오류가 발생한 후 프로세스를 어떻게 중단하거나 되돌릴 것입니까?