Lewati ke konten utama

Pustaka sumber terbuka

Powerduck dibangun dari paket npm kecil yang dapat digabungkan. Klien desktop dan layanan cloud memakai pustaka yang sama, sehingga komponen yang sama dapat berjalan secara lokal, melalui jaringan, atau di dalam alat Anda sendiri.

Setiap paket diterbitkan secara mandiri dengan panduan instalasi, referensi API, dan contoh masing-masing. Halaman ini menjelaskan fungsi dan hubungan antar paket.

Susunan lapisan​

Powerduck / Cloud
↓
Antarmuka yang dapat disematkan
↓
Alur kerja
↓
Dasar

Parser dan konverter membentuk dasar. Alur kerja dibangun di atasnya, lalu antarmuka yang dapat disematkan berada di lapisan teratas. Dasar bersama menjaga perilaku konsisten tanpa mengimplementasikan ulang penguraian pada setiap paket.

Daftar paket​

Dasar​

PaketKegunaan
@powerduck/openapi-parserMengurai, memvalidasi, dan meningkatkan versi dokumen OpenAPI/Swagger
@powerduck/conf-patchMenerapkan perubahan konfigurasi terstruktur dan tervalidasi
@powerduck/x-to-openapiMengonversi format lain, seperti cURL dan Postman, menjadi OpenAPI

Alur kerja​

PaketKegunaan
@powerduck/openapi-cliAlur kerja multiprotokol melalui baris perintah, termasuk menjalankan skenario
@powerduck/openapi-codegenMembuat kode klien dan artefak lain dari spesifikasi
@powerduck/openapi-mcp-serverMenyediakan spesifikasi OpenAPI sebagai server MCP
@powerduck/openapi-requestMenjalankan permintaan yang dijelaskan dalam spesifikasi

Antarmuka yang dapat disematkan​

PaketKegunaan
@powerduck/oas-documentMerender OpenAPI sebagai dokumentasi yang mudah dibaca, termasuk entri React
@powerduck/md-editorEditor Markdown yang dapat disematkan
@powerduck/schema-editorEditor JSON Schema yang dapat disematkan
@powerduck/treeKomponen pohon untuk data terstruktur
@powerduck/workspace-yamlIntegrasi YAML ruang kerja

Memilih paket yang tepat​

  • Membaca, memvalidasi, atau meningkatkan versi berkas OpenAPI: mulai dengan openapi-parser.
  • Mengubah cURL atau koleksi Postman menjadi OpenAPI: gunakan x-to-openapi.
  • Menjalankan skenario atau alur multiprotokol melalui baris perintah atau CI: gunakan openapi-cli.
  • Membuat kode klien: gunakan openapi-codegen.
  • Menyediakan API sebagai alat untuk agen AI: gunakan openapi-mcp-server.
  • Menyematkan dokumentasi yang dirender dalam aplikasi React: gunakan oas-document, entri React, dan CSS-nya.
  • Menyematkan editor: gunakan md-editor atau schema-editor.

Berbagi kemampuan dengan agen​

Paket server MCP juga memungkinkan agen AI eksternal menggunakan kemampuan Powerduck. Spesifikasi yang disediakan melalui openapi-mcp-server mengekspos operasinya sebagai alat MCP. Kontrak yang sama untuk dokumentasi dan pembuatan kode dapat dipanggil langsung oleh agen. Dengan demikian, klien desktop, Cloud, dan alat lain yang kompatibel dengan MCP memakai definisi acuan yang sama.

Tentang contoh​

Contoh kode ditulis berdasarkan API paket yang sebenarnya dan dimaksudkan untuk dijalankan sebagaimana ditampilkan. Setelah meningkatkan versi paket, lihat catatan rilis untuk parameter terbaru, bukan menyalin cuplikan versi lama.

Gunakan bilah samping untuk melihat instalasi, konfigurasi, dan referensi API lengkap setiap paket.