API 라이프사이클 믹서 매뉴얼: 단일 진실 소스에는 무엇이 들어가나요?

작성자: Ariel DiFelice, 2023년 6월 9일

바텐더에서는 믹서 매뉴얼이 신뢰할 수 있는 정보원입니다. 이 책에는 수백 가지의 클래식 칵테일 레시피가 포함될 수 있으며, 그 중 일부는 100년이 넘은 레시피일 수도 있고, 다른 일부는 최근에야 현장에 등장한 음료에 대한 레시피일 수도 있습니다. Mixer의 매뉴얼은 또한 바 또는 레스토랑의 제품에 흥미로운 추가를 위한 새롭고 아직 테스트되지 않은 레시피에 대한 영감의 훌륭한 소스가 될 수 있습니다. 오래된 것을 보존하면서 새로운 것에 대한 탐구를 장려하는 이러한 균형 잡힌 행동은 소프트웨어 세계의 API 개발에 귀중한 교훈을 제공할 수 있습니다. API의 "단일 소스"는 여러 면에서 소프트웨어 조직의 자체 믹서 매뉴얼입니다. 이는 소프트웨어가 기능과 성능을 유지하고 고객을 기쁘게 하고 더 많은 것을 위해 다시 방문하도록 하는 경험을 제공하기 위해 올바른 접근 방식을 취할 때 특히 그렇습니다.

우리는 믹솔로지와 이 기술을 수행하는 믹솔로지스트를 상대적으로 새로운 용어로 생각할 수도 있지만, "믹스솔로지스트"라는 단어가 최초로 기록된 것은 1852년으로 거슬러 올라가며 "믹스솔로지"는 그 직후에 이어졌습니다.

믹솔로지스트와 API 개발자, 디자이너의 작업, 사고방식, 열정은 얼마나 유사합니까? 믹솔로지스트의 정의를 확인하고 유사점을 직접 생각해 보세요.

"'믹스솔로지스트'라는 용어는 혼합 음료의 역사를 연구하고, 사용된 재료와 기술에 대해 깊은 이해를 갖고 있으며, 정기적으로 새롭고 혁신적인 혼합 음료를 만드는 사람을 의미합니다. 이들의 직함은 그들이 뒤에서 맡은 업무의 상당 부분을 수행한다는 것을 의미합니다. 새로운 수제 칵테일을 만들고 기존 인기 칵테일에 시그니처 트위스트를 더하는 거죠."

세계 최고의 API 개발자, 설계자, 설계자는 자신의 작업에서 위의 내용을 많이 인식해야 합니다. 그들은 자신의 기술에 대해 깊은 존경심을 갖고 있으며 항상 이를 더욱 연마하고 있습니다. 그들은 소비자의 취향과 입맛을 이해하려고 노력합니다. 그들은 다른 이해관계자의 입력을 고려하여 해당 API를 프로덕션에 "제공"하기 전에 자신의 창작물을 다시 테스트하고 반복하고 테스트합니다.

칵테일 전문가와 바텐더(두 가지 역할을 서로 다른 역할로 보는 경우)처럼 API 수명 주기에 따른 모든 전문가는 소비자, 고객 및 비즈니스의 요구 사항을 이해한 다음 그에 따라 API를 설계하고 개발해야 합니다. 이 프로세스의 핵심 부분은 지속적인 검증과 시장 요구 사항에 대한 적응입니다.

API에 대한 변경 사항은 사소한 변경이라도 상당한 다운스트림 영향을 미칠 수 있습니다. 그리고 오래된 칵테일 제조법을 수정하는 경우에도 마찬가지입니다. 여기에 대시 한 개를 추가하거나 제거하면 음료의 맛이 완전히 바뀔 수 있을 뿐 아니라 음료에 대한 사람들의 관심도 바뀔 수 있습니다.

계획할 API에 대한 "표준" 변경 비율은 없지만 새로운 소프트웨어 릴리스마다 변경이 필요할 것으로 예상할 수 있습니다. 이는 릴리스 주기에 따라 몇 주, 매월 또는 매일 변경이 이루어지고 테스트 및 검증이 필요함을 의미할 수 있습니다. 필요에 따라 임시 변경이 있을 수도 있습니다.

팀에서 중요한 것은 이러한 변경 사항이 API의 기능이나 성능을 방해하지 않는다는 것입니다. 이를 가능하게 하기 위해 팀에서는 일종의 안전망을 제공하기 위해 점점 더 API 계약 테스트를 활용하고 있습니다. 이는 API의 원본, 합의된 필수 기능을 자세히 설명하는 "계약"에 대한 변경 사항을 검증하는 테스트 형식으로 제공됩니다.

API 변경으로 인한 영향을 예측하는 능력은 엔지니어링 팀의 성숙도와 부서, 시간대, 다양한 수준의 기술 전문 지식에 걸쳐 협업할 수 있는 능력에 따라 달라질 수 있습니다. 표준화와 협업을 촉진하는 도구와 지침은 사고로 인해 부정적인 다운스트림 영향을 간과하거나 인식하지 못하는 것을 방지할 수 있습니다.

게시된 API의 최신 버전에 대한 단일 정보 소스를 신뢰할 수 있는지 또는 검증된 음료 레시피에 대한 최신 버전의 혼합기 매뉴얼을 신뢰할 수 있는지 여부에 관계없이 명확하고 간결한 문서는 열쇠. 하지만 이 문서가 단순히 존재하는 것만으로는 충분하지 않습니다.