Управление жизненным циклом¶
Жизненный цикл API – один из ключевых факторов в управлении API. Жизненный цикл API имеет заранее определенные статусы. Эти статусы представляют собой те этапы, которые API проходит в процессе начала разработки API и до его вывода из эксплуатации. Жизненный цикл API и продуктов API, связанных с NEOMSA APIM , состоит из шести следующих стадий, что позволяет определить, в каком статусе находятся API или продукты API в данный момент.
Описания жизненного цикла API
В жизненном цикле API по умолчанию доступны следующие статусы, которые применимы как к API, так и к продуктам API
| Статус жизненного цикла API | Сценарий использования | Действие |
|---|---|---|
| CREATED (СОЗДАН) | API создан, но не доступен для использования. | Метаданные API добавляются на портал разработчика, но они не публикуются в API Gateway и, следовательно, не видны подписчикам на портале разработчика. |
| PRE-RELEASED (ПРЕДВАРИТЕЛЬНО ВЫПУЩЕН) | Прототип создан для того, чтобы обеспечить предварительное развертывание и провести тестирование на потребителе. Вы можете развернуть новый API или новую версию существующего API в качестве прототипа, используя статус PRE-RELEASED. Это позволяет подписчикам получить доступ к предварительной реализации API. | API опубликован на портале для разработчиков в виде предварительной версии. |
| PUBLISHED (ОПУБЛИКОВАН) | API готов к использованию пользователями на портале разработчиков. | API виден на портале разработчиков и доступен для подписки. |
| BLOCKED (ЗАБЛОКИРОВАН) | API временно заблокирован для использования. Издатель может опубликовать API из статуса BLOCKED. | Доступ к API временно заблокирован. Вызовы во время выполнения блокируются, и API больше не отображается на портале разработчиков. |
| DEPRECATED (УСТАРЕВШИЙ) | Старая версия API удаляется, когда создается и публикуется новая версия API. | Когда API становится устаревшим, новые подписки на него отключаются. Однако API по-прежнему развернут в шлюзе и доступен в среде выполнения для существующих подписчиков. Существующие подписчики могут продолжать использовать его в обычном режиме до тех пор, пока API не будет выведен из эксплуатации. |
| RETIRED (УДАЛЁН) | API больше не используется и переведен в статус RETIRED. | API не публикуется на шлюзе API и будет удален с портала разработчиков. |
Жизненным циклом API или API-продуктов могут управлять пользователи с привилегиями публикации, используя портал API Publisher в NEOMSA APIM . Для этого необходимо войти в созданный API и выбрать в меню раздел «Жизненный цикл».
