Руководство по миксеру жизненного цикла API: что входит в единый источник достоверной информации?

Oct 24, 2023

Автор: Ариэль ДиФеличе, 9 июня 2023 г.

Для бармена руководство микшера является надежным источником информации. Эти книги могут содержать сотни рецептов классических коктейлей, некоторым из которых может быть 100 лет, а другим могут быть напитки, появившиеся на сцене совсем недавно. Руководства миксеров также могут стать отличным источником вдохновения для новых, еще не опробованных рецептов интересных дополнений к предложениям бара или ресторана. Этот баланс между сохранением старого и поощрением исследования нового может стать ценным уроком для разработки API в мире программного обеспечения. «Единый источник истины» API во многом является руководством для микшера, выпускаемого самой организацией-разработчиком программного обеспечения. Это особенно верно, когда используется правильный подход, гарантирующий, что программное обеспечение остается функциональным и производительным и обеспечивает впечатления, которые радуют клиентов и заставляют их возвращаться снова и снова.

Хотя мы можем считать миксологию и миксологов, практикующих это ремесло, относительно новыми терминами, первое зарегистрированное использование слова «миксолог» относится к 1852 году, а вскоре после этого последовало слово «миксология».

Насколько схожи работа, образ мышления и увлечения миксологов, разработчиков и дизайнеров API? Ознакомьтесь с этим определением миксолога и посчитайте сходства сами:

«Термин «миксолог» относится к тому, кто изучает историю коктейлей, хорошо разбирается в используемых ингредиентах и ​​методах и регулярно создает новые и инновационные коктейли… их должность подразумевает, что они выполняют значительную часть своей работы за сцены, создавая новые крафтовые коктейли и добавляя свою фирменную нотку уже существующим фаворитам».

Лучшие разработчики API, дизайнеры и архитекторы мира многое из вышеперечисленного должны признать в своих работах. Они глубоко уважают свое ремесло и постоянно совершенствуют его. Они стремятся понять вкусы и вкусы своих потребителей. Они учитывают вклад других заинтересованных сторон, тестируют, повторяют и еще раз тестируют свои творения, прежде чем «подавать» эти API в производство.

Подобно миксологам и барменам (если рассматривать их как две разные роли), каждый профессионал на протяжении жизненного цикла API должен понимать потребности потребителей, клиентов и бизнеса, а затем соответствующим образом проектировать и разрабатывать свои API. Важной частью этого процесса является постоянная проверка и адаптация к требованиям рынка.

Изменения в API, даже незначительные, могут иметь значительные последствия. То же самое можно сказать и об изменениях, внесенных в старинный рецепт коктейля, где добавление или удаление одной капли того или иного напитка может полностью изменить вкус напитка… а также интерес людей к нему.

Хотя не существует «стандартной» скорости внесения изменений в API, которую нужно было бы планировать, вы можете ожидать, что изменения потребуются с каждой новой версией программного обеспечения. Это может означать, что изменения вносятся (и их необходимо тестировать и проверять) каждые несколько недель, каждый месяц или даже каждый день, в зависимости от частоты ваших выпусков. Также могут быть внесены специальные изменения по мере необходимости.

Для команд крайне важно убедиться, что эти изменения не нарушают функциональность или производительность API. Чтобы сделать это возможным, команды все чаще используют тестирование контрактов API, чтобы обеспечить своего рода систему безопасности. Это происходит в форме тестирования, которое проверяет изменения на соответствие «контракту», в котором подробно описывается исходная, согласованная и, следовательно, необходимая функциональность API.

Способность предвидеть влияние изменений в API может зависеть от зрелости команды инженеров и ее способности сотрудничать между отделами, часовыми поясами и различными уровнями технических знаний. Инструменты и рекомендации, способствующие стандартизации и сотрудничеству, могут предотвратить упущение из виду неудач или их слепоту к негативным последствиям.

Говорим ли мы о возможности доверять единственному источнику достоверной информации о самой последней версии опубликованного API или о последнем издании руководства по миксеру с проверенными рецептами напитков, четкая и краткая документация необходима. ключ. Но просто существования этой документации недостаточно.