ADN Open CIS
Сообщество программистов Autodesk в СНГ

Идеология версий API PLM 360

API PLM 360, как и большинство API REST имеют составляющую «версия» в их URL-адресе. Тем не менее, значение версии меняется от системы к системе. Позвольте объяснить, что же значит версия для API PLM 360.

API version является частою URL-адреса, который осуществляет вызов REST. Так, если вы получаете список рабочих мест посредством https://mytenant.autodeskplm360.net/api/v2/workspaces/, «2» является номером версии API. В PM 360 этот номер определяет совместимый набор API. Другими словами, v2 будет отвечать за совместимость при вызове новых версий PLM. Кое-что может быть добавлено в REST v2, но существующее содержимое будет работать по-прежнему.

В какой-то точке будущего будет доступен API v3, который возможно будет несовместим с v2. Когда представляются новые версии API, они будет жить бок-о-бок с существующими версиями API. Это даёт разработчикам достаточно времени для переноса кода на последнюю версию API. Вот грубая диаграмма, иллюстрирующая сказанное.

Там не отмечено время ни для одной позиции. API v3 может выйти через год, два, либо никогда вообще. Таким же образом, не выставлено время окончания v2. Это может произойти через год после выпуска v3, через два года, либо никогда. Всё что можно сказать, так это то, что окончание версии API будет анонсировано заранее.

Версия продукта (product version) для PLM 360 обновляется в каждом основном выпуске PLM 360, которй происходит примерно каждый месяц. Вы можете легко узнать текущую версию, перейдя в /version.txt в вашем узле. На время написания 9.1. является текущей версией. Когда PLM обновляется, новые возможности добавляются в API. Так, если вы желаете назвать специфическую версию схемы API, необходимо включить как версию API, так и версию продукта. Например, «API schema 2:9.1», либо что-то в этом ключе. Большинству из вас нет нужды беспокоится о точных схемах. Версии обычно достаточно. Однако, я посоветовал бы записать номер текущей версии продукта PLM 360 где-нибудь в вашем коде, и/или в справочной документации. Это будет полезная заметка на тот случай, если в дальнейшем вы столкнётесь с какими-либо проблемами.

Источник: http://justonesandzeros.typepad.com/blog/2013/10/api-versioning-for-plm-360.html