새로 생성된 스프린트 브랜치에는 기본적으로 콘텐츠가 없습니다. 이러한 방식은 개발자가 현재 스프린트에 필요한 변경 사항에 집중하는 데 도움이 됩니다. 두 가지 주요 방법을 사용하여 리소스를 추가하고 수정할 수 있습니다.접근 방식 선택하기#
| 방법 | 적합한 경우 | 주요 이점 |
|---|
| 수동 변경 | API-First 개발 | 개발 전 명확한 명세 |
| OAS 가져오기 | Code-First 개발 | 메인 브랜치와의 자동 비교 |
Apidog은 효율성을 높이고 협업 비용을 낮추기 위해 API-First 접근 방식(수동 변경)을 강력히 권장합니다.
수동 변경#
스프린트 브랜치 내에서 콘텐츠를 수동으로 수정하면 개발을 시작하기 전에 API 명세를 명확하게 정의할 수 있습니다.메인 브랜치에서 리소스 포크하기#
현재 스프린트 요구 사항에 따라 기존 엔드포인트, 스키마 또는 응답 컴포넌트를 수정해야 하는 경우:1.
Fork from main을 사용하여 필요한 리소스의 사본을 생성합니다.
메인 브랜치의 최신 변경 사항 가져오기#
스프린트 브랜치에서 작업하는 동안 긴급 업데이트로 인해 메인 브랜치에서 직접 변경이 필요할 수 있습니다. 동기화 하려면 다음을 수행하십시오.1.
메인 브랜치의 연결된 리소스가 업데이트되면 알림을 받게 됩니다.
3.
업데이트를 가져올지 또는 현재 스프린트 브랜치 콘텐츠를 유지할지 선택합니다.
4.
원하는 콘텐츠를 선택하고 업데이트를 확인합니다.
새 리소스 생성하기#
현재 스프린트를 위한 새 엔드포인트, 스키마 또는 응답 컴포넌트를 생성하려면 다음을 수행하십시오.1.
New 기능을 사용하여 현재 스프린트 브랜치에 리소스를 추가합니다.
2.
필요한 상위 폴더가 없는 경우 다음을 사용합니다.Select Endpoint Folders: 기존 폴더를 선택합니다.
New Endpoint Folder: 새 폴더를 생성합니다.
폴더 콘텐츠 재정렬 및 조정하기#
메인 브랜치에서와 동일하게 가져온 리소스 또는 새로 생성한 리소스에 대해 동일한 작업을 수행할 수 있습니다.리소스 삭제 및 복원하기#
스프린트 브랜치에는 메인 브랜치와 동일하게 작동하는 휴지통 기능이 있습니다.동일한 메인 브랜치 리소스를 반복적으로 가져오기, 삭제 및 복원하면 예기치 않은 데이터 문제가 발생할 수 있습니다. 데이터 무결성을 유지하려면 이러한 작업을 최소화하십시오.
목, 비교 및 협업#
스프린트 브랜치의 엔드포인트에는 해당 브랜치에만 적용되는 고유한 목 주소가 있으며, 이는 전적으로 현재 스프린트 브랜치의 엔드포인트 정의에 의존합니다.스프린트 브랜치 리소스를 메인 브랜치의 대응 리소스와 비교하여 구체적인 차이 점을 식별합니다.협업 링크를 통해 스프린트 브랜치 엔드포인트를 다른 프로젝트 멤버와 공유합니다.다른 브랜치에 있는 상태에서 스프린트 브랜치 엔드포인트 협업 링크를 클릭하면 시스템에서 브랜치 전환을 요청합니다. 전환하기 전에 현재 브랜치의 변경 사항을 저장하십시오.
OAS 가져오기#
수동, 예약 또는 API 가져오기 방법을 사용하여 OpenAPI Specification(OAS) 파일을 스프린트 브랜치로 직접 가져올 수 있습니다.스프린트 브랜치로 OAS 가져오기#
1.
왼쪽 상단 모서리에서 대상 브랜치가 선택되어 있는지 확인합니다.
2.
Project Settings → Import Data로 이동합니다.
메인 브랜치와 자동 비교#
OAS를 스프린트 브랜치로 가져올 때 처리 로직은 다음과 같습니다.1.
OAS 파일의 각 엔드포인트의 "Path & Method"를 메인 브랜치와 비교합니다.
2.
동일한 경우: 엔드포인트를 가져오지 않습니다.
3.
다른 경우: 엔드포인트가 메인 브랜치와 연결되어 가져와집니다.
4.
새로운 경우: 스프린트 브랜치에 새 엔드포인트가 생성됩니다.
1.
OAS 파일의 스키마 이름을 메인 브랜치와 비교합니다.
3.
다른 경우: 스키마가 메인 브랜치와 연결되어 가져와집니다.
4.
새로운 경우: 스프린트 브랜치에 새 스키마가 생성됩니다.
메인 브랜치와 비교하여 완전히 변경되지 않은 리소스는 가져오기 후 스프린트 브랜치에 포함되지 않으므로, 개발자가 필요한 변경 사항에 집중하는 데 도움이 됩니다.
