Перейти к основному содержимому

Быстрый старт с Cloud

Это руководство поможет превратить спецификацию на вашем компьютере в страницу документации и конечную точку MCP, которыми можно поделиться.

1. Войдите​

На странице входа выберите Google или GitHub. После авторизации OAuth Powerduck создаст собственную сессию и откроет консоль. Личная организация создаётся автоматически.

2. Добавьте спецификацию​

На панели управления добавьте спецификацию из одного из поддерживаемых источников:

  • Загрузка файла — загрузите файл OpenAPI напрямую;
  • Репозиторий Git — укажите репозиторий, выберите ветку и путь к файлу;
  • URL — импортируйте спецификацию по URL.

Существующие документы OpenAPI 3.0/3.1 и Swagger обновляются до новой версии формата. Данные cURL или Postman можно преобразовать и просмотреть до сохранения.

Как работает прямая загрузка​

Большие файлы загружаются непосредственно в объектное хранилище, а не через сервер API:

  1. Создаётся документ;
  2. приложение запрашивает URL для загрузки, передавая тип и размер содержимого;
  3. файл отправляется прямо в хранилище по предварительно подписанному URL;
  4. загрузка завершается, при этом сохраняются версия и её SHA-256.

Так серверу API не приходится передавать через себя большие объёмы данных.

3. Выберите доступные операции​

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

4. Откройте ссылки​

Когда документ активен, в его рабочей области появляются публичные адреса:

  • Документация — отрисованная документация API в публичном просмотрщике;
  • MCP — управляемая конечная точка MCP с транспортом Streamable HTTP;
  • исходная спецификация также доступна по постоянному URL.

По умолчанию документация включена и защищается только после добавления пароля. Доступность MCP и его ключ доступа настраиваются отдельно.

5. При необходимости защитите доступ​

  • Задайте пароль для просмотра документации и, при желании, срок его действия;
  • создайте ключ доступа MCP для конечной точки;
  • приостановите документ, чтобы временно отключить оба интерфейса.

6. Используйте версии​

Когда API изменится, загрузите новое содержимое как новую версию, сохранив предыдущую. Ссылки могут вести к текущему документу или к определённой версии. Содержимое по ссылке, привязанной к версии, не изменится для читателя.

Следующие шаги​