API 개발자 경험이 중요한 이유

Rajesh Bavanantham제품 관리 이사 | NGINX

이 글은 API Connectivity Manager에 관한 2부작 시리즈의 두 번째 글입니다:

• API 난립을 막는 5가지 방법(그리고 이에 관심을 가져야 하는 이유)
• API 개발자 경험이 중요한 이유 – 이 글

API는 현대 비즈니스의 중심에 있습니다. API는 소프트웨어 개발에서 늘 중요한 역할을 해왔으며, 데이터 통합에 대한 수요가 증가하면서 모든 사업 부문에서 API 도입이 확대되고 있습니다. 하지만 API는 단순히 데이터와 애플리케이션을 연결하는 데 그치지 않습니다. 외부 비즈니스 파트너와 협업하고, 고객에게 서비스를 제공하며, 그 자체로 하나의 제품이 되어 수익을 창출하는 데 필수적입니다.

개발자는 API 경제의 중심에서 핵심적인 역할을 합니다. API를 구축하고 통합하며 유지 관리하는 개발자는 API의 제작자인 동시에 기술적 도입 주체이기도 합니다. 일반적으로 API 개발자 경험이라고 불리는 이들의 경험은 API의 전반적인 성공을 좌우하는 가장 중요한 요소 중 하나입니다. 이 글에서는 API 개발자 경험의 핵심 개념과 IT 리더가 API 경험을 계획할 때 고려해야 할 사항을 살펴봅니다.

1. API 개발자 경험이란 무엇인가요?
2. API 개발자 경험이 중요한 이유는 무엇인가요?
3. 훌륭한 API 개발자 경험을 구축하려면 어떻게 해야 할까요?

API 개발자 경험이란 무엇인가요?

API 개발자 경험은 개발자가 API와 상호 작용하면서 느끼는 전반적인 인식과 감정을 의미합니다. 여기에는 개발자가 API를 애플리케이션에 통합할 때 즐겁고 원활한 경험을 할 수 있도록 하는 인프라, 도구, 프로세스, 지원 및 기타 접점이 포함됩니다. API 개발자 경험은 전반적인 개발자 경험에 속하는 하위 분야입니다.

API 개발자 경험이 중요한 이유는 무엇인가요?

끊임없이 사용자 경험에 집중한 것이 1세대 기술 혁신을 이끌었다면, 차세대 성공 기업은 개발자 경험에 집중함으로써 승리할 것입니다.

API 경제가 계속 확장됨에 따라 어떤 API를 채택할지 결정하는 데 있어 개발자의 영향력이 더욱 커지고 있습니다. API를 찾기 어렵거나, 문서가 충분하지 않거나, 제대로 유지 관리되지 않으면 개발자는 해당 API를 포기하고 더 간단하고 빠른 대안을 선택할 것입니다. 이는 내부 API 프로그램뿐만 아니라 파트너 및 고객을 위한 외부 API에도 동일하게 적용됩니다.

외부 API의 경우 개발자가 귀사의 API 사용을 중단하면 실질적인 비즈니스 손실이 발생합니다. 직접 고객으로부터 얻는 수익뿐만 아니라 고객이 사용하는 제품 및 솔루션으로 이루어진 더 광범위한 생태계에 접근할 기회까지 잃게 됩니다. 내부 API 프로그램 역시 열악한 개발자 경험으로 인해 출시 기간 지연, 개발자 생산성 저하, 재작업 증가 등의 문제를 겪을 수 있으며, 이는 잠재적으로 비즈니스의 성공을 위협할 수 있습니다.

개발자 중심의 세계에서 성공하려면 API 수명 주기의 모든 단계에서 일하는 개발자에게 적합한 도구와 리소스를 제공하는 API 전략이 필요합니다. 이를 위한 가장 좋은 방법은 다음 세 가지 API 사용 유형을 아우르는, 세심하게 설계된 엔드투엔드 API 경험을 개발자에게 제공하는 것입니다:

• API 배포 및 관리
• API 검색 및 테스트
• API 모니터링 및 보안 강화

훌륭한 API 개발자 경험을 구축하려면 어떻게 해야 할까요?

긍정적인 경험을 제공하려면 개발자가 API를 어떻게 사용하는지, 작업을 완료하는 데 무엇이 필요한지, 그리고 궁극적으로 API를 사용하면서 어떤 느낌을 받는지 이해해야 합니다. API와 상호 작용할 페르소나를 정의했다면 전반적인 API 경험을 계획할 수 있습니다.

API 개발자 경험을 설계할 때 고려해야 할 네 가지 원칙은 다음과 같습니다:

1. 사용자 식별 – 누가 API와 상호 작용하나요?
2. 기능 정의 – API는 어떤 기능을 하나요?
3. 사용성 최적화 – API를 얼마나 쉽게 사용할 수 있나요?
4. 경험 향상 – API를 사용할 때 어떤 느낌이 드나요?

각 원칙을 하나씩 살펴보고, 개발자에게 최적의 API 경험을 제공하기 위해 무엇이 필요한지 알아보겠습니다.

1단계: 사용자 파악

특정 고객의 문제를 해결하기 위해 제품을 설계하는 것처럼, 개발자의 요구 사항을 충족할 수 있도록 인프라와 제품 전반의 API 경험을 설계해야 합니다. 개발자는 단순한 최종 사용자가 아니라 전체 인프라를 구축하고 유지 관리하는 주체이기도 합니다.

API 개발자 경험을 설계할 때 고려해야 할 주요 페르소나는 세 가지입니다:

• API 소비자 – 애플리케이션에 필요한 API 통합을 탐색하고 구현하며 유지 관리합니다
• API 소유자 – 서비스용 API를 계획, 구축, 문서화, 테스트, 배포 및 관리
• 인프라 관리자 – 전역 정책을 설정하고 보안 및 규정 준수를 위해 API를 모니터링합니다

추가로 고려해야 할 사용자와 이해관계자가 있을 수 있습니다. 예를 들어 API 소비자 범주에는 내부 개발자, 파트너, 고객 등의 하위 범주가 포함될 수 있으며, 각 범주마다 페르소나와 요구 사항이 다를 수 있습니다.

2단계: 기능 정의

기능은 성공적인 API의 기반입니다. 좋은 API는 개발자가 유용한 데이터나 서비스를 통합하고, 작업을 더 빠르게 완료하며, 새로운 기능을 개발하는 데 드는 전체 시간을 단축할 수 있도록 지원합니다. 주요 고려 사항은 다음과 같습니다:

• API는 어떤 가치를 제공하나요 데이터 또는 서비스와 통합함으로써?
• API가 문제를 얼마나 효과적으로 해결하는가 호출 횟수를 줄이고 데이터를 구조화함으로써?
• API는 얼마나 안정적인가요? 가용성, 신뢰성 및 확장성 측면에서 말입니다.

API의 기능은 API 우선 개발 접근 방식과 밀접하게 연관되어 있습니다. ‘코드 우선’과 달리 ‘API 우선’에서는 코드 개발을 시작하기 전에 API 요청의 구조와 반환되는 데이터에 중점을 두어 API 사양을 작성합니다. 이러한 접근 방식을 통해 API는 개발자에게 필요한 가치와 기능을 일관되게 제공합니다.

3단계: 사용성 최적화

세 번째 원칙인 사용성은 개발자가 API로 무엇을 할 수 있는지가 아니라 API를 어떻게 사용하는지를 다룹니다. 여기에는 API를 탐색하고 학습하며 테스트하고 도입하는 데 도움이 되는 관련 리소스가 포함됩니다. 인프라, 도구, 문서로 구성된 지원 생태계가 없다면 개발자는 API를 사용하는 데 어려움을 겪게 됩니다. 다음과 같은 사항을 중요하게 고려해야 합니다:

• 간편한 가입(통합 싱글 사인온(SSO) 지원 및 손쉬운 API 키 관리)
• 명확하고 상세한 문서와 최신 참고 자료 및 코드 예제
• 빠른 설정 시간으로, 기본 API 요청을 생성하는 데 5분 미만이 소요되는 것이 이상적입니다

Postman의 「2022년 API 현황 보고서」에서 설문 응답자들은 API 사용을 가로막는 주요 장애 요인으로 다음을 꼽았습니다:

• 문서 부족(55%)
• API를 찾기 어려움(38%)
• 기본적인 API 지식 부족(30%)

상세한 문서, 코드 예제, API 테스트 도구를 제공하는 중앙 개발자 포털을 활용하면 이러한 문제를 해결할 수 있습니다.

4단계: 경험 향상

API 개발자 경험은 API 소비자와 API 소유자 간의 모든 상호작용을 아우릅니다. 그 기반은 API의 기능성과 사용성으로 이루어지지만, API를 사용하는 전반적인 만족도를 높이는 추가적인 상호작용도 있습니다. 여기에는 다음이 포함될 수 있습니다:

• 활발한 커뮤니티가 Stack Overflow, Slack, Discord, Twitter 등의 채널에서 운영됩니다.
• 접근하기 쉬운 지원 및 개발팀의 신속한 답변
• 원활한 경험 API, 문서 및 커뮤니티를 이용할 때

귀사의 API를 즐겁게 사용하는 개발자는 동료에게 해당 API를 추천하고, 이를 기반으로 새로운 기능을 구축하며, 자신의 앱에 통합할 가능성이 더 높습니다.

API 개발자 경험이 중요한 이유

탁월한 API 개발자 경험을 제공하려면 API 자체뿐만 아니라 이를 둘러싼 도구, 프로세스, 문서 및 지원 생태계도 중요합니다. API 생태계의 모든 요소가 원활하게 작동하면 불편과 복잡성이 줄어들어 개발자가 애플리케이션 구축에 집중할 수 있습니다.

앞서 설명한 단계는 위에서 API 개발자 경험을 설계하고 구현하며 테스트하고 평가하는 지속적인 프로세스의 일부입니다. 사용자 파악, 기능 정의, 사용성 최적화, 경험 향상이라는 각 주요 단계에 집중하면 즐겁고 재미있게 사용할 수 있는 API를 구축할 수 있습니다.

NGINX는 API 개발자 경험을 어떻게 개선하나요?

API Connectivity Manager, F5 NGINX Management Suite의 일부로, API 개발자 경험을 핵심에 두고 설계되었습니다. API Connectivity Manager를 사용하면 인프라 팀은 고성능 API 게이트웨이와 개발자 포털을 배포할 수 있습니다. 또한 개발자는 API와 문서를 신속하게 게시하고 관리하거나, API를 검색하여 애플리케이션에 연동할 수 있습니다.

API Connectivity Manager의 이점은 다음과 같습니다:

• 빠른 온보딩 – 선호하는 ID 공급자와 통합하여 개발자 포털의 권한 부여 및 인증 절차를 간소화합니다
• 간편한 문서화 – OpenAPI Specification을 사용하여 API 소유자가 API 게이트웨이에 API를 게시할 때 개발자 포털용 문서를 자동으로 생성합니다
• 대화형 학습 – 개발자 포털에 통합된 API 탐색기를 통해 개발자가 API를 살펴보고 테스트하며 학습할 수 있도록 지원합니다
• 워크플로 자동화 – 완전한 선언형 REST API를 사용하여 API 게시 및 관리를 CI/CD 파이프라인에 통합

시작하기

Start a NGINX Management Suite 30일 무료 평가판을 시작하세요 여기에는 API Connectivity Manager와(과) Instance Manager가 포함됩니다.

관련 자료

• 블로그: F5 NGINX Management Suite로 앱과 API를 연결, 확장 및 보호
• 블로그: API 난립을 막는 5가지 방법(그리고 이에 주목해야 하는 이유)
• 솔루션 개요: NGINX Management Suite API Connectivity Manager

작성자 소개

Rajesh Bavanantham제품 관리 이사 | NGINX

Rajesh Bavanantham의 다른 블로그 게시물