블로그 | NGINX

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

NGINX-F5-수평-검정-유형-RGB의 일부
라제쉬 바바난탐 썸네일
라제쉬 바바난탐
2022년 9월 8일 게시

이는 API Connectivity Manager에 대한 2부작 시리즈의 두 번째 게시물입니다.

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

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

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

API 개발자 경험이란?

API 개발자 경험은 개발자가 API와 상호 작용하는 동안 갖는 전반적인 인식과 감정을 설명합니다. 여기에는 API를 애플리케이션에 통합하는 개발자에게 즐겁고 마찰 없는 경험에 기여하는 인프라, 도구, 프로세스, 지원 및 기타 터치포인트가 포함됩니다. API 개발자 경험은 전반적인 개발자 경험의 하위 관행입니다.

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를 사용하는 데 어려움을 겪을 것입니다. 중요한 고려 사항은 다음과 같습니다.

  • 통합된 Single Sign‑On(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 개발자 경험을 개선하나요?

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

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

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

시작하기

API Connectivity Manager 와 Instance Manager가 포함된 NGINX Management Suite의 30일 무료 평가판을 시작하세요.

관련 자료

F5 NGINX에 대한 더 많은 블로그 게시물 읽기 ›

"이 블로그 게시물에는 더 이상 사용할 수 없거나 더 이상 지원되지 않는 제품이 참조될 수 있습니다. 사용 가능한 F5 NGINX 제품과 솔루션에 대한 최신 정보를 보려면 NGINX 제품군을 살펴보세요. NGINX는 이제 F5의 일부가 되었습니다. 이전의 모든 NGINX.com 링크는 F5.com의 유사한 NGINX 콘텐츠로 리디렉션됩니다."