skills.rest
webiny
webinyOFFICIAL
Explore all skills by this author →
Website𝕏@WebinyCMSGitHub

webiny-api-catalog

Catalogs Webiny API abstractions with import paths and source references.

8.0k|673|Updated Jan 9, 2018
Search Tags:#api#catalog#cms#typeScript#abstractions#webiny#Serverless
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-catalog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webiny-api-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending Webiny's serverless CMS backend struggle to discover which abstractions, use cases, and event handlers exist and where to import them from. This Skill provides a searchable catalog of 34 core API abstractions with exact import paths and source file locations.

Core Features & Use Cases

  • Abstraction Discovery: Lists core Webiny API abstractions such as Ai, EventPublisher, KeyValueStore, Logger, Encryption, and Websockets use cases with their import statements.
  • Source Mapping: Each entry links to its source file in packages like @webiny/api-core, @webiny/api-websockets, and @webiny/feature so you can read exact interfaces and types.
  • Use Case: When building a custom Webiny API extension, look up the EventPublisher abstraction, copy its import from "webiny/api", then read the referenced source file to implement a domain event handler correctly.

Quick Start

Ask the AI to find the Webiny API abstraction for publishing domain events and show its import path and source file.

Frequently Asked Questions about webiny-api-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find Webiny API abstractions for backend extensions?▼

Browse the catalog entries grouped by name, each showing the import statement from "webiny/api" and the source file path. Read the referenced source file to get the exact interface and types before implementing.

How do I publish domain events in Webiny API?▼

Import EventPublisher from "webiny/api" and extend the DomainEvent base class for your event. The source is located in @webiny/api-core/features/eventPublisher/index.ts.

Does Webiny API support AI provider integrations?▼

Yes, the catalog lists Ai, AiSdk, AiSdkFactory, AiConnectionFactory, and AiSdkTool abstractions from @webiny/api-core/features/ai. Register one SDK factory per provider namespace such as OpenAI or Anthropic.

What is the difference between KeyValueStore and GlobalKeyValueStore in Webiny?▼

KeyValueStore is tenant-scoped, isolating data per tenant, while GlobalKeyValueStore is non-tenant-scoped and shared across the deployment. Both are defined in @webiny/api-core/features/keyValueStore.

How do I handle Webiny websockets connections in code?▼

Use abstractions like WebsocketsRunner, ConnectionRegistry, WebsocketsSendToConnectionsUseCase, and WebsocketsDisconnectUseCase from @webiny/api-websockets. Route plugins are created with createWebsocketsRoutePlugin.

Related Skills

Explore More Software Engineering Skills→
fycd2006fycd2006

admin-developer

Build and wire admin features with React views, DI, and MobX.

Community
Advanced
webinywebiny
8.0k

backend-developer

Implement backend API features using Webiny architecture and GraphQL schemas.

Official
Advanced
PoliklotPoliklot
19

bitrix

Generates secure, production-ready code for 1C-Bitrix CMS 23+ projects using D7 and legacy APIs.

Community
Advanced
FriendlyInternetFriendlyInternet
10

audit

Audit monorepo documentation against source code using Bash, Read, Grep, and Glob.

Official
Advanced