Руководство по именованию и стилю
Последовательные соглашения для URL, полей и ответов об ошибках по каждому API, который бизнес строит или предоставляет.
API и интеграции
Установка стандарта проектирования, которому следуют многие API: версионирование, именование, аутентификация и документация, до того как десяток команд придумают собственные соглашения.
Бизнесу с одним API редко нужен стандарт того, как API должны выглядеть. У бизнеса с десятком API, построенных разными разработчиками за несколько лет, обычно есть десяток слегка разных соглашений об именовании, аутентификации и обработке ошибок, и каждой новой интеграции приходится изучать каждое из них с нуля. Устранить этот разрыв вот зачем растущий бизнес в Дубае решает нанять API-архитектора в Дубае: не чтобы лично строить каждый API, а чтобы задать форму, которой должен следовать каждый API.
OpenAPI Initiative, вендорно-нейтральный проект под эгидой Linux Foundation, описывает свою спецификацию на собственной странице часто задаваемых вопросов как стандартный, не привязанный к языку программирования способ описать REST API, чтобы и люди, и инструменты могли понять сервис, не читая его исходный код. API-архитектор обычно принимает такой стандарт как общий язык для всего бизнеса, а затем строит поверх него конкретные правила именования, версионирования и аутентификации, которые делают десяток API единым слаженным продуктом, а не десятком разрозненных.
Что даёт эта роль
Стандарты, которые применяют другие разработчики, плюс процесс проверки, который держит их применёнными.
Последовательные соглашения для URL, полей и ответов об ошибках по каждому API, который бизнес строит или предоставляет.
Единый последовательный подход к тому, как API проверяют вызывающего, вместо того чтобы каждый API придумывал собственную схему.
Как вносится критическое изменение без незаметной поломки каждого приложения, уже вызывающего старую версию.
Последовательное, актуальное, машиночитаемое описание для каждого API, так что новая интеграция не начинается с чистого листа.
Лёгкая проверка перед тем, как построят новый API, ловящая несогласованность, пока её ещё легко исправить.
Часто первый API, построенный по новому стандарту, используемый затем как рабочий пример, а не только документ.
Важные навыки
Проектное суждение и способность заставить другие команды действительно следовать стандарту.
| Навык или инструмент | Как выглядит хороший уровень | Почему это важно |
|---|---|---|
| Стандарты описания API | Свободно владеет общим форматом, например OpenAPI, и уверенно проверяет проект другого разработчика по нему | Общее машиночитаемое описание вот что делает руководство по стилю применимым на практике, а не декларативным |
| Суждение о версионировании | Имеет чёткую, продуманную позицию о том, когда и как версионировать, а не просто “версионировать всегда всё” | Излишнее версионирование создаёт собственную нагрузку на поддержку, а недостаточное ломает интеграции без предупреждения |
| Паттерны безопасности | Понимает распространённые подходы к аутентификации API и когда какой подходит | Слабый стандарт аутентификации, применённый последовательно, всё равно остаётся слабым стандартом |
| Коммуникация с разработчиками | Может объяснить стандарт достаточно ясно, чтобы разработчики действительно ему следовали без жёсткого контроля | Руководство по стилю, которое никто не читает и не соблюдает, на практике бесполезно |
| Прагматизм | Задаёт стандарт, подходящий реальному масштабу бизнеса, а не фреймворк, построенный для гораздо более крупной организации | Чрезмерно усложнённый процесс управления замедляет небольшую команду, не добавляя реальной ценности |
Страница часто задаваемых вопросов OpenAPI Initiative отмечает, что её спецификацию поддерживают более 40 организаций по всей отрасли, о чём стоит упомянуть кандидату: тому, кто свободно владеет широко принятым, вендорно-нейтральным стандартом, легче включиться в новый проект, чем тому, кто работал только внутри частных соглашений одной компании.
Форматы работы с нами
Консалтинг подходит большинству компаний, впервые нанимающих на эту роль, поскольку основной результат, руководство по стилю, политика версионирования и процесс проверки, это ограниченный объём консультационной работы, а не постоянная поставка функций. Проект с фиксированным объёмом подходит бизнесу, который также хочет, чтобы архитектор спроектировал и построил первый эталонный API по новому стандарту. Выделенный найм подходит более крупному бизнесу, постоянно добавляющему новые API, где стандарт должен развиваться вместе с ними. Поддержка в подборе персонала подходит бизнесу, который хочет иметь API-архитектора в штате на долгий срок.
Оценка кандидата
Проверки, показывающие, действительно ли заданный им стандарт применялся.
Не общий шаблон, а построенное для реального бизнеса, и что он намеренно опустил как ненужное для масштаба этого бизнеса. Это лучший вопрос, который стоит задать, прежде чем нанять API-архитектора в Дубае, поскольку он мгновенно отделяет реальную практику от теории.
Конкретный пример решения о версионировании, что сломалось и что он сделал бы иначе, показывает больше, чем любое определение версионирования. Это честный вопрос для любого, кого вы решите нанять как API-архитектора в Дубае для бизнеса с уже работающими интеграциями.
Был ли он принят добровольно или потребовалось принуждение, многое расскажет о том, насколько практичным и понятно изложенным он на самом деле был.
Ясная, актуальная документация один из самых заметных признаков того, что стандарт действительно соблюдается, а не лежит в ящике. Прежде чем нанять API-архитектора в Дубае, этот образец часто самый быстрый способ оценить качество его прошлой работы.
Сильный кандидат масштабирует процесс управления вниз для меньшего бизнеса, а не применяет крупный корпоративный процесс независимо от размера.
Сертификации
Ни один сертификат напрямую не подтверждает суждение в архитектуре API.
В отличие от некоторых более узких технических навыков, единого, широко признанного сертификата именно для архитектуры или управления API не существует. Собственная архитектурная сертификация облачной платформы, например от AWS, Microsoft Azure или Google Cloud, актуальна только там, где эта платформа центральна для рассматриваемых API.
Настоящее руководство по стилю, настоящее решение о версионировании и доказательство того, что разработчики действительно следовали стандарту, расскажут вам куда больше, чем любой сертификат. Это доказательства, которые стоит запрашивать всякий раз, когда вы готовитесь нанять API-архитектора в Дубае.
Особенности ОАЭ
Оба пункта легче заложить с самого начала, чем встраивать задним числом.
Федеральный закон ОАЭ о защите данных применяется к персональным данным, обрабатываемым через электронные системы, независимо от того, где происходит обработка. API-архитектор может встроить правила согласия и доступа прямо в стандарт аутентификации, чтобы каждый API наследовал их автоматически, а не обрабатывал отдельно.
Там, где API нужно аутентифицировать пользователя через UAE PASS, национальную цифровую личность, UAE PASS публикует руководство по интеграции OAuth2 для веб-приложений. API-архитектор, задающий более широкий стандарт аутентификации, должен учесть, как этот поток вписывается рядом с ним, о чём стоит заговорить заранее с любым, кого вы решите нанять как API-архитектора в Дубае для публичного продукта.
Если непосредственная потребность это один API, а не стандарт для многих, наша страница API-разработчика подходит точнее. Бизнесам, подключающим существующие системы, а не проектирующим собственные публичные или внутренние API, стоит прочитать наши страницы архитектора интеграции или разработчика интеграции вместо этого. Как только стандарт API задан, командам, строящим сервисы, которые его предоставляют, часто также нужна наша страница архитектора микросервисов. Эта роль входит в нашу категорию API и интеграций, часть найма разработчиков в Дубае.
Прямые ответы
API-разработчик строит один API по брифу. API-архитектор решает, какого стандарта должен придерживаться каждый API в бизнесе, например соглашений об именовании, версионирования и того, как работает аутентификация, так что разные API, построенные разными разработчиками, всё равно выглядят последовательно для тех, кто ими пользуется.
Обычно пока нет. Эта роль окупается, когда у бизнеса уже есть или планируется достаточно API, чтобы несогласованность между ними начала создавать реальные трения, будь то для внутренних разработчиков, партнёров или клиентов, интегрирующихся с вами.
Проверку новых проектов API перед тем, как их построят, ведение руководства по стилю и решения о том, как версионируются и сообщаются критические изменения, чтобы изменение одного API незаметно не сломало каждое приложение, которое его вызывает.
Да, особенно в начале сотрудничества, где хорошее проектирование одного API часто становится эталонным примером, вокруг которого строится остальная часть стандарта.
Они пересекаются, но не идентичны. Архитектура API фокусируется именно на том, как проектируются и управляются ваши собственные API. Архитектура интеграции шире и охватывает общий шаблон обмена данными между системами, который может строиться вокруг API, а может и нет.
Источники
Фиксированная цена в письменном виде
Получили. Мы уже готовим ваше предложение.
В рабочее время вы получите его в течение 45 минут. Проверьте почту, там письмо с подтверждением.