오픈 API는 기술 팀이 사용자와 서비스를 공유하고 데이터를 공유하기 위한 중요한 도구입니다. 비즈니스가 성장하고 기술이 발전함에 따라 API는 정기적으로 업데이트되어야 합니다. 이러한 업데이트는 일반적으로 새로운 시장 요구를 충족하고, 기존 기능을 개선하고, 새로운 기능을 추가하거나, 보안 취약점을 해결하기 위해 설계됩니다.
여러 API 버전이 동시에 실행되어야 하는 경우가 많기 때문에 팀은 이러한 버전을 효과적으로 관리해야 합니다. 일부 사용자는 새로운 기능에 액세스하기 위해 최신 버전이 필요할 수 있는 반면, 다른 사용자는 이전 버전의 안정성과 친숙함을 선호할 수 있습니다.
이러한 다양한 요구를 충족하기 위해 팀은 종종 최신 버전, 안정적인 버전 또는 장기 지원 버전과 같은 여러 API 버전을 제공합니다. 이는 다양한 사용자 그룹에 대한 호환성과 안정성을 보장하여 이전 버전 의존 사용자에게 업그레이드로 인한 혼란을 최소화합니다.
Apidog의 API 버전 기능은 여러 버전을 관리하기 쉽게 설계되었습니다. 이를 통해 팀은 서로 독립적으로 작동하고 다른 버전과 명확히 구별되는 각 버전을 만들고, 관리하고, 유지할 수 있습니다.
API 버전 생성 단계별 가이드
1단계: API 버전 생성
프로젝트에 들어가면 프로젝트 폴더 위의 브랜치 스위처로 가서 API Versions를 선택하여 현재 프로젝트의 모든 버전을 확인합니다. New API Version을 클릭하여 새 버전을 생성합니다. 버전 이름을 지정하고 초기 내용을 선택합니다.
저장 후 시스템은 자동으로 새 버전으로 전환되어 해당 버전의 리소스를 원래 버전에 영향을 주지 않고 편집할 수 있습니다.
2단계: 문서에서 API 버전 게시
API 버전이 생성된 후 프로젝트 내의 "문서 공유 -> 문서 사이트 게시" 섹션으로 이동합니다.
Edit를 클릭하여 게시할 API 버전을 선택합니다. 버전의 출처, 표시할 버전 번호, 실행 환경 및 슬러그를 설정할 수 있습니다.
슬러그는 공용 액세스 주소 뒤에 오는 특정 API 버전의 고유 식별자 역할을 합니다. 예를 들어 URL https://example.Apidog.cn/2-0-0에서 2-0-0이 슬러그이며, 외부 사용자가 해당 API 버전의 특정 버전에 직접 접근할 수 있도록 합니다. 이는 각 API 버전이 유니크하고 명확한 접근 경로를 가지도록 보장합니다.게시된 버전의 순서를 변경할 수도 있습니다. 목록의 첫 번째 버전이 기본 버전으로 설정되며, 사용자가 버전을 지정하지 않고 프로젝트에 접근할 경우 표시됩니다.
이 설정을 완료한 후 게시를 클릭합니다. 프로젝트는 게시됨으로 표시되며, 사용자는 문서 링크를 통해 API 문서에 접근하여 서로 다른 버전 간에 전환할 수 있습니다.
3단계: API 버전의 엔드포인트 빠른 공유
API 버전을 게시하는 것 외에도 API의 모든 버전에서 특정 엔드포인트를 공유할 수 있습니다.
이를 위해 공유 링크를 생성하고, API 버전을 선택한 다음 공유할 엔드포인트를 선택합니다.
공유 링크가 생성되면 사용자는 해당 API 버전의 선택된 엔드포인트를 볼 수 있습니다.
4단계: API 버전 삭제
API 버전을 삭제하려면 메인 브랜치의 "프로젝트 설정 -> API 버전"으로 이동합니다.
삭제되면 공용 문서에 해당 버전이 더 이상 포함되지 않으며, 해당 버전과 연결된 모든 공유 링크는 유효하지 않게 됩니다. 이는 사용자가 삭제된 버전에 대한 콘텐츠에 더 이상 접근할 수 없도록 보장합니다.
API 버전 관리 FAQ
1. API 버전과 스프린트 브랜치의 차이점은 무엇인가요?
API 버전: 주로 외부 출판에 사용됩니다. 이전 버전과 호환되지 않는 주요 변경 사항이 발생할 때 새로운 버전을 생성하는 것이 좋습니다. API 버전은 전체 엔드포인트 집합을 포함합니다.
스프린트 브랜치: 내부 팀 개발에 사용됩니다. 각 반복마다 새로운 브랜치가 생성되며 완료되면 메인 브랜치에 통합됩니다. 스프린트 브랜치는 일반적으로 새로 추가되거나 수정된 엔드포인트만 포함합니다.
2. API 버전 기능은 모든 유형의 프로젝트를 지원하나요?
현재 이 기능은 HTTP 프로젝트만 지원합니다.
3. 누가 API 버전을 생성하거나 수정할 수 있나요?
프로젝트 관리자는 API 버전을 생성하고 수정할 수 있습니다.
4. 누가 API 버전을 게시하거나 삭제할 수 있나요?
오직 프로젝트 관리자만이 API 버전을 게시하거나 삭제할 수 있습니다.
5. 하나의 API 버전에서 변경하면 다른 버전에도 영향을 미치나요?
아니요. 각 API 버전은 독립적으로 작동하므로 하나의 버전에서 리소스 변경 사항은 다른 버전에는 영향을 미치지 않습니다.
6. 다국어 지원과 같은 추가 기능을 지원할 계획이 있나요?
네, 우리는 다국어 지원 및 교차 브랜치/버전 풀과 같은 기능을 적극적으로 개발하고 있습니다. 이러한 기능은 API 문서 관리를 개선하기 위해 향후 버전에 추가될 것입니다.
7. 스프린트 브랜치에 대한 향상은 어떤가요?
스프린트 브랜치 기능에 대한 지속적인 업그레이드가 진행 중이며, 다른 브랜치에서 리소스를 복사하거나 선택하고, 브랜치 병합 리뷰 및 브랜치 잠금 기능이 포함됩니다. 이러한 향상은 예정된 업데이트에 포함될 것입니다.
결론
Apidog의 API 버전 관리 기능은 팀이 여러 API 버전을 쉽게 생성, 관리 및 유지할 수 있게 해줍니다. 이는 새로운 기능이 도입되는 동안 이전 버전이 안정적으로 유지되도록 보장합니다. 단일 API를 관리하든, 다양한 사용자 그룹에 대한 여러 버전을 관리하든, Apidog는 프로세스를 간소화하여 호환성을 유지하고 사용자에게 미치는 혼란을 최소화합니다.
