기사
Atlassian Compass로 내부 API 카탈로그 구축
KATIE SILVER
ATLASSIAN 수석 제품 매니저
핵심 요약
핵심 요약 위치
시간
4분 읽기. Compass 설정에 걸리는 시간은 10분 미만입니다.
대상 그룹
소프트웨어 제공 팀의 일원이며 API를 사용합니다. 개발자, 엔지니어 등 모두가 이점을 얻을 수 있습니다.
필수 조건
- Compass 받기 - 무료로 사용해 볼 수 있으며 시작하는 데 몇 분밖에 걸리지 않습니다.
정확한 API 카탈로그 구축의 어려운 문제
지난 10년 동안 Atlassian은 거대한 모놀리스를 마이크로서비스, 분산 아키텍처 및 자율적인 팀으로 전환했습니다. 이점은 실제로 존재하지만, 그에 따른 결과도 있습니다. 이전에 타입 컴파일러 및 테스트는 대규모 코드베이스의 모든 부분이 원활하게 함께 작동하도록 유지했습니다. 오늘날 경계는 API이며, 배포되면 모든 것이 함께 작동할 것인지 명확하지 않습니다.
Atlassian은 모두가 API의 작동 방식과 변경 사항을 이해할 때 개발자가 더 빠르게 움직이고 팀이 더 나은 제품을 제공한다는 것을 알고 있습니다. 어려운 부분은 설명서를 추적하고 유지 관리하는 것입니다.
모든 조직은 서비스를 매핑하는 것에 대해서는 성숙도 수준이 서로 다릅니다. 일부 팀에서는 Slack에서의 대화를 통해 API 생산자와 소비자 간의 정렬을 이루며, 다른 팀에서는 각 API가 작동하는 방식이 서비스를 만들 때 문서화되지만 업데이트되지는 않습니다. 적절한 프로세스 또는 도구가 마련되어 있다면 모든 API가 문서화되고 변경 사항이 다른 이해 관계자에게 자동으로 커뮤니케이션됩니다.
여정의 어느 단계에 있든, Atlassian의 새로운 개발자 플랫폼인 Compass가 도움이 될 수 있습니다.
Compass를 사용한 중앙 집중식 API 설명서
마이크로서비스 환경에서 API 설명서는 어디에 있어야 합니까? 서비스를 개별적으로 빌드하고 배포하기 때문에 각 서비스에 자체 호스팅 문서 사이트를 만들거나 OpenAPI 파일을 찾기 힘든 위치에 두어야 하는 것은 아닙니다. 팀은 API 레지스트리를 구축하기 위한 대규모 내부 작업 없이도 모든 정보를 한곳에 모아 검색 가능하게 만들어야 합니다.
Compass를 사용하면 몇 주 또는 몇 달이 아닌 한 시간 만에 모든 API 설명서를 쉽게 중앙 집중식으로 관리할 수 있습니다. 변경할 때마다 수동으로 설명서를 업로드할 필요가 없습니다. SCM(Bitbucket, GitHub 또는 GitLab)을 Compass에 연결하기만 하면 됩니다.
몇 분 내에 Compass가 모든 리포지토리에서 OpenAPI 파일을 스캔하고 카탈로그에 게시합니다. 모든 팀의 모든 API가 즉시 중앙 집중식으로 처리되고 검색 가능하게 됩니다.
API 검색 및 통합
개발자가 새로운 환불 흐름을 구축하는 티켓을 맡는다고 가정해 보겠습니다. 환불을 처리하는 데 사용할 올바른 API를 찾아야 한다는 것은 알고 있지만, 어디서 시작해야 할지 모릅니다. 많은 회사에서는 Slack에서 질문을 올리고 지구 반대편에 있는 동료가 어떤 API를 사용해야 하는지에 대한 질문에 답변해 줄 때까지 몇 시간씩 기다리곤 합니다. Compass가 있는 팀에서는 이 모든 것을 셀프 서비스로 처리할 수 있습니다. 개발자는 API 엔드포인트를 검색하고 Compass 내에서 몇 초 만에 필요한 정확한 정보를 찾을 수 있습니다. 즉, 정보를 찾는 개발자는 더 빠르게 찾을 수 있고 해당 API를 소유한 팀은 업무 중단을 덜 경험하게 됩니다.
API 변경 사항에 대한 알림 받기
마이크로서비스 환경에서는 모든 서비스가 자율적으로 배포되며, 때로는 소비자가 알아야 할 방식으로 변경됩니다. 다행히 Compass는 API 설명서에 대해서만 알고 있는 것이 아니라 시간이 지남에 따라 API가 어떻게 변화하고 있는지도 알고 있습니다. 동료가 API 설명서를 업데이트하는 풀리퀘스트를 병합할 때마다 Compass도 설명서 버전을 업데이트하므로, 개발자가 Compass에서 보는 버전은 항상 최신 API입니다.
과거의 중요한 변경 사항이 언제 발생했는지 확인할 수 있도록 기록 변경 사항이 변경 로그 페이지에도 표시됩니다.
개발자에게 필요한 설명서가 있으면 코드를 더 빠르게 배포 가능
Postman의 최근 API 개발자 설문 조사에서 개발자의 52%가 API 작업 시 직면한 가장 큰 문제는 설명서 부족이라고 답했습니다. 설명서가 없으면 개발 속도가 느려지고 새로운 엔지니어의 온보딩이 더 어려워지고 소프트웨어의 신뢰성이 떨어집니다.
자체 내부 API 카탈로그를 빌드해야 하는 경우 많은 구성 요소가 포함된 대규모 프로젝트가 될 것입니다. Atlassian이 이 모든 것을 대신하므로, 중앙 집중식 설명서 허브를 몇 분 만에 구축할 수 있습니다.
팀에 필요한 정보를 제공하여 더 빠르게 제품을 제공하도록 하세요 🚀.