[가이드] 포스트맨 버전 관리 API

일관되고 잘 문서화된 API 수정 사항을 유지하는 것은 효율적인 API 개발에 중요합니다. 그러나 다양한 버전을 관리하고 팀 내에서 변화에 효과적으로 협력하는 것은 복잡한 작업이 될 수 있습니다.

이 가이드는 Postman의 통합 버전 관리 시스템의 기능을 탐색하여 API 버전을 효과적으로 관리하고 협업을 원활하게 하며 수정의 명확한 감사 기록을 유지할 수 있도록 합니다. 이러한 기능을 활용하여 보다 체계적이고 효율적인 API 개발 워크플로우를 보장할 수 있습니다.

Postman이란 무엇인가요?

Postman은 API 개발을 위한 중앙 허브 역할을 하며, 프로그래머가 프로세스를 간소화하도록 돕습니다. 종합적인 기능을 갖춘 이 도구는 설계, 테스트 및 문서화 기능을 포함합니다. 이러한 기능 통합으로 인해 Postman은 다양한 API 관련 프로젝트를 다루는 개발자들이 선호하는 도구로 자리잡았습니다.

Postman의 버전 관리란 무엇인가요?

Postman의 버전 관리는 여러분과 팀이 API를 공동으로 작성하고 수정할 수 있도록 합니다. 버전 관리는 다음과 같은 사항을 전문적으로 관리합니다:

API 컬렉션: 컬렉션은 URL, 매개변수, 헤더 및 본문 내용을 포함하는 API 요청을 정의합니다.

API 환경: API 환경 변수는 컬렉션 내에서 사용되도록 Postman 버전 관리에 저장됩니다. 이를 통해 사용자는 개발, 테스트 및 프로덕션 환경 간에 쉽게 전환할 수 있습니다.

API 모의: API 모의는 API 끝점에 대한 서버 응답을 시뮬레이션하여 테스트 목적으로 유용합니다.

Postman의 버전 관리 기능

Postman의 버전 관리는 개발자가 API 개발 프로세스를 극대화할 수 있도록 다양한 기능을 제공합니다. 예를 들면:

변경 사항 추적

• 컬렉션, 환경 및 모의에 대한 수정의 명확한 기록을 유지합니다.
• 특정 변경을 누가 만들었는지 파악하고 책임과 협력을 개선하기 위해 정확한 타임스탬프를 확인합니다.

포킹 및 머지

• Git 워크플로우에서 영감을 받아 Postman은 요소(컬렉션, 환경, 모의)의 복사본(포크)을 생성하여 독립적인 작업을 허용합니다.
• 수정이 완료되면 변경 사항을 쉽게 주 버전에 머지하여 협업을 간소화하고 개별 기여를 통합합니다.

풀 리퀘스트

• 팀원들이 주 버전에 머지하기 전에 제안된 변경 사항을 검토하도록 하여 투명한 개발을 촉진합니다.
• 이 협업 프로세스는 작업 흐름을 방해하기 전에 잠재적인 충돌을 식별하고 해결하는 데 도움이 됩니다.

버전 이력

• 컬렉션, 환경 및 모의의 과거 반복에 접근할 수 있습니다.
• 이 역사적 기록을 통해 필요한 경우 이전 버전으로 되돌릴 수 있으며, 원하지 않는 수정의 경우 안전망을 제공합니다.

외부 버전 관리 시스템과의 통합

• Postman의 내장 시스템은 API 아티팩트를 관리하는 데 뛰어나지만 Git과 같은 외부 시스템과 통합할 수도 있습니다.
• 이 동기화를 통해 Postman 컬렉션의 변경 사항을 코드베이스와 함께 단일 리포지토리에서 관리할 수 있어 API 정의에 대한 통합된 진실 소스를 촉진합니다.

Postman API 버전 관리 샘플 데모

이 Postman API 버전 관리의 샘플 데모는 Git 리포지토리를 사용하는 것을 포함할 것입니다.

Postman에서 API 생성

Postman 창의 왼쪽 상단 모서리에 있는 New 버튼을 클릭하여 새 요청을 생성합니다. 위 이미지와 같이 HTTP 요청을 선택하여 새 요청을 생성합니다.

API 메서드 및 세부정보 입력

생성할 API 요청의 세부정보를 포함합니다. 이에는 URL, HTTP 메서드 및 API가 필요로 하는 추가 매개변수와 같은 구성 요소가 포함되어야 합니다.

팀 설정 선택

팀 설정을 클릭하여 계속 진행합니다.

설치된 앱 선택

추가 구성을 위해 웹페이지로 리디렉션됩니다. 이 페이지에서 왼쪽 수직 목록에 있는 설치된 앱을 찾습니다. GitHub Enterprise Server 또는 GitLab Self-Managed가 있는 경우, 이러한 앱이 이 화면에 표시됩니다.

GitHub 리포지토리의 도메인 URL 입력

GitHub 리포지토리의 도메인 URL을 입력합니다. 다음과 같은 형식이어야 합니다:

GitHub Enterprise Server: https://my-github-server.example.com

GitLab Self-Managed: https://gitlab.example.com

OAuth 앱 생성

사용 중인 Git 공급자에 따라 OAuth 앱을 생성하기 위한 지침을 따릅니다.

• 홈페이지 URL - Postman 홈페이지 URL을 입력합니다: https://www.postman.com
• Authorization callback URL 또는 Redirect URI - Postman에서 제공하는 인증 콜백 URL을 입력합니다: https://integration-oauth.pstmn.io/v1/api-git-callback.html
• Scopes - OAuth 앱을 생성할 때 적절한 스코프를 선택하여 Postman이 리포지토리에 읽고 쓸 수 있도록 해야 합니다. GitHub의 경우 repo 및 user 스코프를 선택합니다. GitLab Self-Managed의 경우 api 스코프를 선택합니다.

OAuth 앱을 만들면 클라이언트 ID와 비밀을 복사하여 Postman에 입력합니다.

Apidog와의 단순하고 직관적인 협업

Apidog는 Postman을 대체할 수 있는 강력한 API 개발 플랫폼입니다. 믿을 수 있는 협업과 Apidog에 내장된 독특한 버전 관리 시스템 덕분에 사용자는 팀으로 함께 협력하여 전문적으로 API를 효율적으로 개발할 수 있습니다.

Apidog로 API 구축하기

Apidog를 사용하면 팀과 함께 몇 번의 클릭만으로 API를 생성할 수 있습니다.

시작하려면 위 이미지와 같이 New API 버튼을 누르세요.

API의 다양한 특성을 정의하여 진행합니다. 이 섹션에서는 다음을 수행할 수 있습니다:

• HTTP 메서드 지정: 원하는 서버 작업을 정의하기 위해 적절한 HTTP 메서드(GET, POST, PUT 또는 DELETE)를 선택합니다.
• API 엔드포인트 URL 정의: 클라이언트-서버 상호작용을 촉진하는 특정 API 엔드포인트 URL(또는 API 주소)을 표시합니다.
• 매개변수 추가(선택 사항): 동적으로 포함할 하나 이상의 매개변수를 API URL에 포함시켜 요청을 사용자화합니다.
• 기능 설명 제공: API의 의도된 기능을 설명하는 간결한 설명을 작성합니다.

Apidog로 버전 관리하기

API의 설계 섹션에서 위 이미지와 같이 작은 정사각형 아이콘을 클릭합니다. 그러면 API의 변경 로그 섹션으로 이동합니다.

이 목록에서 보고 싶은 업데이트를 선택할 수 있습니다.

마지막으로, API의 한 버전에서 다른 버전으로 수행된 변경 사항을 관찰할 수 있습니다. 변경이 언제 이루어졌고 누가 변경했는지 알 수 있습니다. 만약 API의 이전 버전이 필요한 경우, 사용자들은 선택한 이전 버전으로 되돌릴 수 있는 옵션도 갖추고 있습니다.

결론

Postman의 버전 관리 기능을 효과적으로 활용하면 개발자는 보다 체계적이고 협업적인 API 개발 환경을 조성할 수 있습니다. 이 가이드는 변경 사항 추적, 포킹 및 머지와 같은 기능을 통한 팀 협업 촉진, API 수정의 명확한 이력 유지에 대한 지식을 제공하였습니다.

잘 정의된 버전 관리 전략은 작업 흐름을 간소화하고 충돌을 방지하며 API의 원활한 발전을 보장하는 데 중요한 역할을 합니다. Postman의 내장된 기능을 활용하고 외부 시스템과의 통합 가능성을 탐색하여 개발 팀이 권한을 부여받는 버전 관리 접근 방식을 구축하도록 하십시오.