API가 적극적으로 발전하는 경우 버전 간의 호환성을 유지하고 단일 변경으로 수십 개의 클라이언트 통합이 중단되는 상황을 피하는 것이 중요합니다. 변경 사항을 제어하고 사용자에게 위험없이 API를 원활하게 업데이트 할 수있는 정식 버전의 계약을 구현합니다.
이는 다른 클라이언트가 다른 버전의 인터페이스를 사용하는 마이크로 서비스 아키텍처, B2B 통합 및 개방형 API 제품에 중요합니다.
우리가 말하고있는 것
| 오브젝트 | 설명 |
|---|---|
| OpenAPI 사양 | 모든 버전의 문서 및 계약을 유지 |
| 엔드 포인트 | (PHP 3 = 3.0.6, PHP 4) |
| 계약 (Pact, Dredd) | 클라이언트와 서버 간의 상호 작용 조건 수정 |
| 데이터 모델 | 요청 및 응답 구조의 변경 사항을 모니터 |
우리가 구현하는 방
여러 API 버전을 병렬로 지원합니다- 모든 편지 선택 (c)
- 각 계약 버전의 자동 조달 (Pact, Postman, Jest, Dredd)
- Git 또는 CI/CD를 통한 사양 검증
- 각 변경 사항에 대한 고객을위한 문서 및 변경
장점
통합의 안정성 보장- 고객을 "파괴" 할 위험없이 새로운 기능을 출시하는 기능
- 버전 간 마이그레이션 단순화
- 명확한 변경 이력 및 계약 제어
- 외부 및 내부 개발 팀을위한 투명성
특히 중요한 곳
다중 의존성 마이크로 서비스 아키텍처- 공개 또는 B2B API 플랫폼
- 장기 계약을 맺은 금융 및 결제 시스템
- 안정적인 API에 의존하는 모바일 앱
계약 버전은 API에 대한 예측 가능성과 신뢰의 기초입니다. 모든 당사자의 호환성과 투명성을 유지하면서 통증없이 API를 변경하고 개발할 수있는 프로세스를 구현합니다.
문의하기
아래 양식을 작성해주시면 최대한 빨리 답변드리겠습니다.