URI-based Versioning для AWS API Gateway

Question

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

https://<my-domain>/v1/names?starts-with=<value> 

Однако ближайший я могу получить API шлюза на

https://<my-domain>/names/v1?starts-with=<value> 

... что вполне назад.

У меня на консоли есть «Имена API» с ресурсом «v1», поддерживающим метод GET. У меня также есть настраиваемая настройка домена для сопоставления базового пути «имен» с «Имена API» и этапа «Тест». Базовый путь должен быть уникальным, поэтому, ставя «v1», есть только краткосрочная победа; как только я создаю свой второй API (например, Numbers API), он тоже будет иметь v1, и я не смогу создать второе сопоставление.

Любая помощь очень ценится, поскольку я сейчас не в идеях.

Answer 1

Не создавайте путь версии (/ v1) как ресурс в вашем API. Вместо этого просто вызовите API «Имена V1» и начните создавать ресурсы (/ names). Если вы хотите внести изменения и создать новую версию API, мы рекомендуем создать совершенно новый API под названием «Names V2». Еще раз, просто создайте свои ресурсы без пути к версии.

Чтобы объединить два API вместе, вы можете использовать пользовательские имена доменов. Пользовательское доменное имя в Gateway API включает как полное доменное имя, так и базовый путь. Создайте два пользовательских доменных имен:

• myapi.com/v1 -> указывает на стадии прод имен V1 API
• myapi.com/v2 -> указывает на стадии прод имен V2 API

Таким образом, вы можете сохранить исправление ошибок v1 при внесении изменений в v2 и развернуть оба API независимо. Пользовательское доменное имя приведет их вместе и сделает их отображаемыми в одном домене (myapi.com/v2/names).

Надеюсь, это поможет.