MTB ESB Documentation

Настройка в Publisher

Создание API, API Product, backend route и Developer Portal documentation.

Настройка в WSO2 Publisher

Publisher используется для создания и управления API. До публикации конфигурация должна быть проверена в Dev и связана с версионируемым OpenAPI-контрактом.

Интерфейс и возможности зависят от установленной версии платформы. Для шагов, не определённых внутренней policy, сверяйтесь с официальной документацией WSO2 API Manager.

API или API Product

АртефактИспользовать, когда
APIПубликуется самостоятельный набор связанных operations
API ProductConsumer получает единый продукт из operations одного или нескольких API

Исходные API могут оставаться управляемыми артефактами, а Consumer подписывается на опубликованный API Product. Не создавайте Product только ради дополнительного уровня навигации.

Создание API

  1. Импортируйте или создайте OpenAPI definition.
  2. Проверьте name, context, version и visibility.
  3. Настройте endpoint/backend согласно выбранному flow.
  4. Укажите production и sandbox endpoints, если модель их использует.
  5. Настройте resources, methods и operation-level policies.
  6. Примените security schemes и scopes.
  7. Настройте throttling/subscription tiers.
  8. Добавьте документацию и безопасные examples.
  9. Сохраните API в CREATED для проверки.

Backend route

Consumer-facing API не должен ссылаться прямо на случайный adapter pod или Kafka broker. Backend является стабильной платформенной точкой маршрута, согласованной с architecture design.

FlowТипичный backend route
DirectWSO2 → Router → adapter topic
AsyncWSO2 → Router/Kafka → adapter → Callback Service
OrchestratedWSO2 → orchestration topic → Kestra flow

API Product

Перед созданием Product:

  • исходные API и operations должны существовать;
  • версии и owners должны быть совместимы;
  • security и subscription model должны быть понятны;
  • Product description объясняет ценность Consumer, а не внутреннюю сборку.

После добавления operations настройте Product subscription policy, документацию и lifecycle. Публикация Product не отменяет поддержку исходных API-артефактов.

Документация для Developer Portal

Обязательно добавьте:

  • назначение и аудиторию;
  • quick start;
  • authentication и required scopes;
  • request/response examples;
  • error codes;
  • rate limits;
  • idempotency и retry guidance;
  • sync/async behavior;
  • support и deprecation information.

Не публикуйте внутреннюю конфигурацию

Developer Portal предназначен для Consumer. Kafka credentials, internal hostnames, admin URLs, secrets, database details и инструкции операторов размещаются в закрытой платформенной документации.

On this page