Настройка в 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 Product | Consumer получает единый продукт из operations одного или нескольких API |
Исходные API могут оставаться управляемыми артефактами, а Consumer подписывается на опубликованный API Product. Не создавайте Product только ради дополнительного уровня навигации.
Создание API
- Импортируйте или создайте OpenAPI definition.
- Проверьте name, context, version и visibility.
- Настройте endpoint/backend согласно выбранному flow.
- Укажите production и sandbox endpoints, если модель их использует.
- Настройте resources, methods и operation-level policies.
- Примените security schemes и scopes.
- Настройте throttling/subscription tiers.
- Добавьте документацию и безопасные examples.
- Сохраните API в
CREATEDдля проверки.
Backend route
Consumer-facing API не должен ссылаться прямо на случайный adapter pod или Kafka broker. Backend является стабильной платформенной точкой маршрута, согласованной с architecture design.
| Flow | Типичный backend route |
|---|---|
| Direct | WSO2 → Router → adapter topic |
| Async | WSO2 → Router/Kafka → adapter → Callback Service |
| Orchestrated | WSO2 → 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 и инструкции операторов размещаются в закрытой платформенной документации.