Импорт API для микросервисов Istio
Этот документ поможет вам быстро объявить API для микросервисов, чтобы более эффективно контролировать и управлять вашими API.
Содержание
Выбор сервиса
В левой навигационной панели нажмите Service List и введите сервис, для которого хотите объявить API.
Объявление API сервиса
Перейдите на вкладку API.
Существует два способа объявления API сервиса:
- Batch Import API — объявление API сервиса путём импорта файла описания API, соответствующего спецификации Swagger.
- Manual Import API — если нужно добавить в список API всего несколько API, вы можете вручную добавить API сервиса на платформе.
Batch Import API
Пакетный импорт API осуществляется путём загрузки файла описания API, поддерживающего спецификацию Swagger (.yaml или .json), либо путём ввода URL документа API, соответствующего спецификации OpenAPI 3.0.
Примечание:
- При пакетном импорте API существующие API в списке API, которые были установлены через пакетный импорт на уровне Service Port, будут сначала очищены. Если вы хотите сохранить существующие API, импортируйте вручную только новые необходимые API.
- Размер загружаемого файла описания API не должен превышать 5 МБ; количество импортируемых API за один раз не должно превышать 2000.
Объяснение параметров
Для настройки соответствующих параметров обратитесь к следующим пояснениям.
| Параметр | Описание |
|---|---|
| Service Port | Порт прослушивания, на котором сервис принимает запросы API. Этот порт является внутренним маршрутом сервиса, отображающим номер порта связанного Deployment внутри кластера. Если сервис имеет несколько портов, по умолчанию выбирается первый порт сервиса. |
| File Import | Пакетный импорт API из загруженного файла, поддерживающего спецификацию Swagger (.yaml или .json), загружаемого из локального хранилища. |
| Auto Load | Пакетный импорт API из документа по URL, соответствующему спецификации OpenAPI 3.0. Например: http://<domain>:<port>/v3/example/api-docs. |
Ручной импорт API
Объяснение параметров
Для настройки соответствующих параметров обратитесь к следующим пояснениям.
| Параметр | Описание |
|---|---|
| Service Port | Порт прослушивания, на котором сервис принимает запросы API. Этот порт является внутренним маршрутом сервиса, отображающим номер порта связанного Deployment внутри кластера. Если сервис имеет несколько портов, по умолчанию выбирается первый порт сервиса. |
| API | Путь запроса API: Введите путь запроса в соответствии с выбранным методом сопоставления. Точное совпадение: например, /path будет точно соответствовать данным запроса этого API;Регулярное выражение: например, /path/{param}/path, где {param} — переменная в API.Метод запроса API: одиночный выбор, поддерживаются GET, PUT, POST, DELETE, PATCH, HEAD, OPTIONS. |
Результаты и проверка
Независимо от того, используете ли вы Batch Import или Manual Import, после успешного объявления вы можете просмотреть объявленные API в списке API ниже.