Skills Development GraphQL API Response Abstractions

GraphQL API Response Abstractions

v20260825
webiny-api-graphql-catalog
This module provides essential GraphQL response abstractions and helper types. It includes standardized structures for handling various API outcomes, such as general success responses, list data, common errors, and specific security statuses (e.g., Not Found, Not Authorized). Using these abstractions ensures that API interactions are robust, predictable, and adhere to consistent patterns.
Get Skill
256 downloads
Overview

api/graphql

How to Use

  1. Find the abstraction you need below
  2. You MUST read the source file to get the exact interface and types!
  3. Import: import { Name } from "<importPath>";
  4. See webiny-use-case-pattern or webiny-event-handler-pattern skills for implementation patterns

Abstractions


Name: ErrorResponse Import: import { ErrorResponse } from "webiny/api/graphql" Source: @webiny/api-graphql/responses.ts Description: GraphQL error response helper.


Name: GraphQLSchemaFactory Import: import { GraphQLSchemaFactory } from "webiny/api/graphql" Source: @webiny/api-graphql/graphql/abstractions.ts Description: Define custom GraphQL schema extensions.


Name: ListErrorResponse Import: import { ListErrorResponse } from "webiny/api/graphql" Source: @webiny/api-graphql/responses.ts Description: GraphQL list error response helper.


Name: ListResponse Import: import { ListResponse } from "webiny/api/graphql" Source: @webiny/api-graphql/responses.ts Description: GraphQL list response helper.


Name: NotAuthorizedResponse Import: import { NotAuthorizedResponse } from "webiny/api/graphql" Source: @webiny/api-core/graphql/security/NotAuthorizedResponse.ts Description: GraphQL not-authorized response helper.


Name: NotFoundResponse Import: import { NotFoundResponse } from "webiny/api/graphql" Source: @webiny/api-graphql/responses.ts Description: GraphQL not-found response helper.


Name: Response Import: import { Response } from "webiny/api/graphql" Source: @webiny/api-graphql/responses.ts Description: GraphQL response helper.


Info
Category Development
Name webiny-api-graphql-catalog
Version v20260825
Size 1.8KB
Updated At 2026-09-06
Language