A set of backend Webiny Control Panel (WCP)-related features.
npm install --save @webiny/api-wcp
Or if you prefer yarn:
yarn add @webiny/api-wcp
The @webiny/api-wcp package contains essential backend Webiny Control Panel (WCP)-related utilities.
| Example | Description |
|---|---|
| Registering Plugins | Shows how to register relevant plugins in a handler function. |
Type Declaration
export declare const createWcpContext: () => ContextPlugin<WcpContext>;Creates the WCP context API.
import { createHandler } from "@webiny/handler-aws";
import { createWcpContext } from "@webiny/api-wcp";
export const handler = createHandler({
plugins: [
// Registers WCP context API.
createWcpContext(),
// ...
]
});Type Declaration
export declare const createWcpGraphQL: () => GraphQLSchemaPlugin<WcpContext>;Returns WCP API URL. The default URL can be overridden via the WCP_API_URL environment variable.
import { createHandler } from "@webiny/handler-aws";
import { createWcpGraphQL } from "@webiny/api-wcp";
export const handler = createHandler({
plugins: [
// Registers WCP context API.
createWcpGraphQL(),
// ...
]
});