May 2025
Beginner to intermediate
232 pages
2h 58m
Korean
Content preview from 웹 API 설계
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
Start your free trial
4장. 디자인 모범 사례
이 작품은 AI를 사용하여 번역되었습니다. 여러분의 피드백과 의견을 환영합니다: translation-feedback@oreilly.com
이전 장에서는 웹 API를 통해 데이터를 전송하는 다양한 접근 방식에 대한 개요를 살펴보았습니다. 이제 전송 환경에 익숙해지고 다양한 패턴과 프레임워크 중에서 선택하는 방법을 이해하셨으니 개발자가 API를 최대한 활용할 수 있도록 몇 가지 전술적 모범 사례를 제공하고자 합니다.
실제 사용 사례를 위한 설계
API를 설계할 때는 구체적인 실제 사용 사례에 근거하여 결정을 내리는 것이 가장 좋습니다. 이 아이디어를 좀 더 자세히 살펴봅시다. API를 사용하는 개발자에 대해 생각해 보세요. 개발자가 API를 통해 어떤 작업을 수행할 수 있어야 하나요? 개발자는 어떤 유형의 앱을 만들 수 있어야 하나요? 어떤 회사에서는 "개발자가 고객 신용카드로 요금을 청구할 수 있어야 한다"와 같은 목표가 있을 수 있습니다. 다른 회사에서는 좀 더 개방적인 대답을 내놓을 수도 있습니다: "개발자는 소비자용 대화형 애플리케이션의 전체 제품군을 만들 수 있어야 합니다."라고 답할 수도 있습니다.
사용 사례를 정의한 후에는 개발자가 API를 사용하여 원하는 작업을 실제로 수행할 수 있는지 확인하세요.
API는 애플리케이션의 내부 아키텍처를 기반으로 설계되어 구현의 세부 정보가 유출되는 경우가 많습니다. 이는 써드파티 개발자에게 혼란을 야기하고 개발자 경험에 좋지 않은 영향을 미칩니다. 그렇기 때문에 회사의 내부 인프라를 노출하는 것이 아니라 외부 개발자가 API와 상호 작용할 때 가져야 하는 경험에 초점을 맞추는 것이 매우 중요합니다. 주요 사용 사례를 정의하는 방법에 대한 구체적인 예는 5장의"주요 사용 사례 개요" 섹션을 참조하세요.
디자인을 시작하면 구현과 테스트 전에 많은 '만약의 경우'를 상상하기 쉽습니다. 이러한 질문은 브레인스토밍 단계에서 유용하지만, 한 번에 너무 많은 문제를 해결하려는 유혹에 빠져 디자인을 잘못 이끌 수 있습니다. 특정 워크플로 또는 사용 사례를 선택하면 하나의 디자인에 집중한 다음 사용자에게 효과가 있는지 테스트할 수 있습니다.
참고
개발자 대상을 특정 대상으로 좁히는 데 도움이 필요하면 8장을 참조하세요.
뛰어난 개발자 경험을 위한 디자인
사용자 인터페이스를 통해 제공되는 사용자 경험에 대해 고민하는 것처럼, API를 통해 제공되는 개발자 경험( )에 대해서도 생각해 보는 것이 중요합니다. 개발자는 API를 포기하는 것에 대한 기준이 낮기 때문에 나쁜 경험은 곧 이탈로 이어집니다. 마찬가지로 사용 편의성은 개발자가 API를 계속 사용하기 위한 최소한의 조건입니다. ...