도구와 스키마 버전 관리

다른 사용자가 연결하면 도구 이름과 인수의 형태에 의존합니다. 이를 부주의하게 변경하면 모든 클라이언트가 한꺼번에 작동하지 않게 됩니다.

기본값이 있는 선택적 매개변수를 추가하면 기존 호출자가 계속 작동합니다. 기존 호출자는 보내지 않는 새 필드를 간단히 무시합니다.

도구 이름을 바꾸거나, 인수를 삭제하거나, 인수를 필수로 바꾸면 호환성이 깨집니다. 기존 클라이언트는 더 이상 맞지 않는 호출을 갑자기 보내게 됩니다.

필드를 발전시키려면 새 필드를 추가하고 기존 필드는 유지하세요. 호출자가 마이그레이션할 수 있도록 기존 필드의 설명에 사용 중단 예정이라고 표시하세요.

실제로 호환성을 깨야 한다면 v1과 함께 v2 도구를 제공하세요. 두 버전을 한동안 모두 실행하면 클라이언트가 각자의 속도에 맞춰 전환할 수 있습니다.

서버는 핸드셰이크 중에 이름과 버전을 알립니다. 클라이언트가 어떤 릴리스에 연결했는지 확인할 수 있도록 버전을 올리세요.

유의적 버전 관리를 사용하세요. 수정 사항에는 패치 버전을, 기능을 추가할 때는 마이너 버전을, 호환성을 깨는 변경에는 메이저 버전을 올리세요. 버전 번호가 변경 내용을 보여 줍니다.

결과에 필드를 추가하는 것은 대체로 안전하지만, 필드를 삭제하면 호환성이 깨집니다. 클라이언트가 구문 분석하는 약속으로 출력 스키마를 다루세요.

모든 도구와 스키마 변경 사항을 변경 기록에 남기세요. 업그레이드하는 사용자는 무엇이 이동했고, 무엇이 새로 추가되었으며, 무엇이 사라졌는지 확인해야 합니다.

기존 도구가 언제 삭제될지 알리세요. 명확한 종료 날짜를 제시하면 누구도 갑자기 곤란해지지 않으면서 마이그레이션을 유도할 수 있습니다.

릴리스 전에 이전 클라이언트가 호출하는 방식으로 테스트를 실행하세요. 그러면 형식 검사기가 발견하지 못하는 우발적인 호환성 문제를 잡을 수 있습니다.

추가적인 변경을 우선하고, 삭제하기 전에 사용 중단을 예고하며, 실제로 호환성을 깨는 변경에는 v2를 제공하고, 유의적 버전 관리를 따르며, 변경 기록을 유지하세요. 자신 있게 배포할 수 있습니다! 🚀