API가 시장 수요를 충족하고 기술 발전을 활용하기 위해 발전함에 따라, 버전 관리는 필수적입니다. Open API는 기술 팀이 서비스와 데이터를 외부에 제공하는 중요한 채널 역할을 합니다. 그러나 비즈니스의 발전과 기술적 진보는 필연적으로 엔드포인트의 여러 버전 반복으로 이어집니다. 팀이 기능을 최적화하고, 새로운 기능을 도입하며, 버그를 해결함에 따라 이러한 변화는 자연스럽고 필요합니다.여러 API 버전을 관리하는 것은 호환성과 혁신을 모두 보장하면서 다양한 사용자 그룹에 서비스를 제공하는 데 중요합니다. 이 접근 방식은 팀이 버전 제어를 유지하고, 기존 사용자에게 발생하는 중단을 최소화하며, 비즈니스 연속성과 안정성을 보장하면서 안정적이고 지속적으로 발전하는 서비스를 제공할 수 있도록 합니다.
전체 버전 생성기존 API 버전을 기반으로 새 API 버전을 생성할 수 있으며, 원본 버전의 모든 엔드포인트 사본이 포함됩니다. 생성 후에는 해당 버전 내의 각 엔드포인트를 필요에 따라 수정할 수 있습니다. 또는 빈 API 버전에서 시작하여 엔드포인트를 수동으로 추가할 수도 있습니다.
포괄적인 공유프로젝트에서 하나 이상의 API 버전을 선택하여 게시할 수 있습니다. 선택한 버전 내의 모든 엔드포인트가 사용자에게 표시됩니다. 게시할 때 독자 경험을 향상시키기 위해 API 버전의 표시 이름과 slug 설정을 구성할 수 있습니다.
원클릭 전환여러 API 버전이 게시된 경우, 사용자는 공개 페이지의 프로젝트 이름 옆에 있는 버전 선택기를 통해 버전 간에 전환할 수 있습니다. 특정 버전을 클릭하면 해당 버전과 관련된 모든 엔드포인트 및 콘텐츠가 표시됩니다.
"API Version"과 "Sprint Branch"의 차이점
API Version: 외부 릴리스를 위해 설계되었으며, 특히 주요 변경 사항으로 인해 버전 간에 상당한 비호환성이 발생하는 경우에 사용됩니다. 수정되었거나 새로 추가된 엔드포인트뿐만 아니라 모든 엔드포인트를 포함합니다.
Sprint Branch: 개발 팀 내부에서 사용되며, 애자일 개발의 "sprint" 개념과 일치합니다. 각 sprint는 일반적으로 변경되지 않은 엔드포인트를 제외하고 새 엔드포인트 또는 수정된 엔드포인트만 포함하는 브랜치를 생성합니다.