Может ли Swagger / другая документация / инструмент API предоставлять информацию, если конечная точка отдыха потребляет внешние конечные точки отдыха - PullRequest
0 голосов
/ 28 февраля 2019

Недавно пришлось провести анализ по остальным конечным точкам в системе (в архитектуре микросервисов), которые потребляют изнутри внешние конечные конечные точки покоя.Эти конечные точки принадлежат либо другим микросервисам, либо сторонним веб-сервисам.

Просто любопытно узнать, можно ли настроить Swagger для этого или есть какой-либо другой инструмент, который может помочь мне в сборе или визуализации этой информации.

1 Ответ

0 голосов
/ 28 февраля 2019

Просмотр OpenAPI Spec (ранее известного как файл Swagger) не выглядит так, как будто он определяет подключенные конечные точки.Это имеет смысл, поскольку его целью является определение интерфейса к API, а не его реализация.Тем не менее, он дает возможность ссылаться на внешнюю документацию, используя Внешний объект документации .Это может ссылаться на документацию о том, какие конечные точки использует данный API.

Если вы хотите в режиме реального времени посмотреть, какие конечные точки потребляют ваши службы, взгляните на Новые реликвии - Карта услуг и Instana - Карты зависимостей .Я уверен, что другие инструменты APM делают это тоже, но это те два, которые я знаю.Недостатком этого является то, что они не бесплатны.

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

...