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

Библиотеки с открытым кодом

Powerduck состоит из небольших комбинируемых npm-пакетов. Настольный клиент и облачный сервис используют одни библиотеки, поэтому те же компоненты работают локально, по сети или внутри ваших инструментов.

Каждый пакет выпускается независимо и имеет собственные инструкции по установке, справочник API и примеры. Здесь описаны их назначение и взаимосвязи.

Слои архитектуры​

Powerduck / Cloud
↓
Встраиваемый интерфейс
↓
Рабочие процессы
↓
Основа

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

Пакеты​

Основа​

ПакетНазначение
@powerduck/openapi-parserРазбор, проверка и обновление документов OpenAPI/Swagger
@powerduck/conf-patchПрименение структурированных и проверенных изменений конфигурации
@powerduck/x-to-openapiПреобразование других форматов, например cURL и Postman, в OpenAPI

Рабочие процессы​

ПакетНазначение
@powerduck/openapi-cliМногопротокольные процессы из командной строки, включая запуск сценариев
@powerduck/openapi-codegenГенерация клиентского кода и других артефактов из спецификации
@powerduck/openapi-mcp-serverПредоставление спецификации OpenAPI как MCP-сервера
@powerduck/openapi-requestВыполнение запросов, описанных спецификацией

Встраиваемый интерфейс​

ПакетНазначение
@powerduck/oas-documentОтображение OpenAPI как читаемой документации, включая точку входа React
@powerduck/md-editorВстраиваемый редактор Markdown
@powerduck/schema-editorВстраиваемый редактор JSON Schema
@powerduck/treeКомпонент дерева для структурированных данных
@powerduck/workspace-yamlИнтеграция YAML рабочего пространства

Выбор подходящего пакета​

  • Чтение, проверка или обновление файла OpenAPI: начните с openapi-parser.
  • Преобразование cURL или коллекции Postman в OpenAPI: используйте x-to-openapi.
  • Запуск сценариев или многопротокольных процессов из командной строки либо CI: используйте openapi-cli.
  • Генерация клиентского кода: используйте openapi-codegen.
  • Предоставление API как инструментов ИИ-агента: используйте openapi-mcp-server.
  • Встраивание документации в приложение React: используйте oas-document, его точку входа React и CSS.
  • Встраивание редактора: используйте md-editor или schema-editor.

Предоставление возможностей агентам​

Пакет MCP-сервера также даёт внешним ИИ-агентам доступ к возможностям Powerduck. Спецификация, обслуживаемая через openapi-mcp-server, представляет операции как инструменты MCP. Тот же контракт, который используется для документации и генерации кода, агент может вызывать напрямую. Настольный клиент, Cloud и другие совместимые с MCP инструменты сохраняют единое эталонное описание.

О примерах​

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

В боковой панели доступны установка, конфигурация и полный справочник API каждого пакета.